Documentation sidebar

The documentation sidebar is the sidebar that is rendered on the docs and visualizer pages.

There are two sidebar options you can configure through your eventcatalog.config.js file.

eventcatalog.config.js

docs: {
    sidebar: {
        // LIST_VIEW or TREE_VIEW (default is LIST_VIEW)
        type: 'TREE_VIEW',
    }
}

1. LIST_VIEW (default)
   • will render your docs as you see in the demo
2. TREE_VIEW
   • will render the DOCS as a tree view and map your file system folder structure.

Can be useful for large catalogs and navigation

Each sidebar type has a level of configuration you can find below.

Configuring message labels and badges

Added in eventcatalog@2.29.3

You can override the label and badge shown for each message.

To do this you can use the sidebars property in your message documentation.

eventcatalog.config.js

docs: {
    sidebars: {
        'docs': [
            {
                type: 'category',
                label: 'Documentation',
            }
        ]
    }
}