Copy as Markdown[View as Markdown](/docs/sdk/functions/getCustomDocs.md)

***

# Function: getCustomDocs()

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

Defined in: custom-docs.ts:52

Returns all custom docs for the project.

## Parameters[​](#parameters "Direct link to Parameters")

| Parameter   | Type     |
| ----------- | -------- |
| `directory` | `string` |

## Returns[​](#returns "Direct link to Returns")

`Function`

### Parameters[​](#parameters-1 "Direct link to Parameters")

| Parameter       | Type                  |
| --------------- | --------------------- |
| `options`?      | { `path`: `string`; } |
| `options.path`? | `string`              |

### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<`CustomDoc`\[]>

## Example[​](#example "Direct link to 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' });
```