jooy2/vitepress-sidebar

[Feature Request] Add property to ignore folder level

Opened this issue · 2 comments

sharpchen commented

Hi, thank you for your wonderful extension! I've encountered a problem due to what I have done to organize my folder structure.

Feature Motivation

Here's an example structure, I'd like to ignore the sub1 level, regard file.md as a child of sub1.

docs
|
+---document
|   +---folder1
|   |   +---sub1
|   |   |   +---chapter1
|   |   |       +---file.md
|   |   +---demo
|   +---folder2 
|
+---

Feature Description

Could let the property like this, since sub1 is the second level from the /doc/document

sidebar: generateSidebar({
            documentRootPath: '/docs/document',
            folderLevelIgnored: [2]
        }),
jooy2 commented

Hello. Thank you for using vitepress-sidebar.

You can use the excludeFolders option to not show certain folders in the menu.
If the above option is not what you want, does your description mean that you don't want to show the sub1 folder, but you want to show the file.md file?

Regards,

sharpchen commented

I mis-expressed. Yes I'd like to ignore sub1, then the structure should be folder1->chapter1->file.md. All files and folders displayed should be under the folder1.

  • 👍1