Function: getCustomDocs()

getCustomDocs(directory): (options?) => Promise<CustomDoc[]>

Defined in: custom-docs.ts:52

Returns all custom docs for the project.

Parameters

Parameter	Type
directory	string

Returns

Function

Parameters

Parameter	Type
options?	{ path: string; }
options.path?	string

Returns

Promise<CustomDoc[]>

Example

import utils from '@eventcatalog/utils';

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

// Gets all custom docs from the catalog
const customDocs = await getCustomDocs();

// Gets all custom docs from the given path
const customDocs = await getCustomDocs({ path: '/guides' });