Skip to main content

rmCustomDoc

Callable

  • rmCustomDoc(directory: string): (filePath: string) => Promise<void>

  • Delete a custom doc by its' path

    @example
    import utils from '@eventcatalog/utils';

    const { rmCustomDoc } = utils('/path/to/eventcatalog');

    // removes a custom doc at the given path
    // Removes the custom doc at docs/guides/inventory-management/introduction.mdx
    await rmCustomDoc('/guides/inventory-management/introduction');