Function: rmCustomDoc()

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

Defined in: custom-docs.ts:122

Delete a custom doc by its' path

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
filePath	string

Returns

Promise<void>

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');