adrianvlupu / C4-Builder

This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.
https://adrianvlupu.github.io/C4-Builder/
MIT License
562 stars 93 forks source link

feat(web): add the ability to exclude folder of the sidebar #83

Open Jeconias opened 1 year ago

Jeconias commented 1 year ago

Why

In some situations, I need to create static files to customize the page, but it should not appear in the sidebar.

What

In the build process is checked if dist starts with any value of the array options (excludeSidebarFolderByPath), if true, the folder is ignored to show no sidebar, otherwise, will be rendered.

How to use

Just add a new option in .c4builder:

{
  "excludeSidebarFolderByPath": [
    "src/configs"
  ]
}

Example

My project: image

Output without this feature: image

Output with this feature: image