VuePress sidebar and navbar generator based on file and directory structure. Focus your documents, not sidebar or navbar.
Overview
VuePress has revolutionized the way we manage our documentation with the introduction of the vuepress-bar. This innovative sidebar and navbar generator simplifies the configuration process by automatically structuring them based on your existing file and directory hierarchy. By shifting the focus from static menus to dynamic document organization, the vuepress-bar enhances user experience and provides a streamlined navigation solution.
With powerful features that cater to both new and experienced users, the vuepress-bar allows for customized sorting, multiple sidebars, and even advanced parameter passing in directory names. Whether you’re working on a simple project or a comprehensive documentation site, this tool is designed to adapt to your needs while keeping the content front and center.
Features
- Navbar & Sidebar Creation: Automatically generates a navbar and sidebar using the directory structure, making documentation navigation intuitive and efficient.
- Custom Sorting: Use numeric prefixes or order meta to arrange directories and files, ensuring users find what they need quickly.
- Multiple Sidebars: Easily support multiple sidebars for different sections of your documentation without requiring extensive configuration.
- README.md Integration: Automatically includes README.md in the first available group, just like on the VuePress website, which helps in maintaining structured content.
- Advanced Parameter Handling: Pass parameters such as collapsible settings and sidebar depth directly in directory names for advanced customization.
- Filtering with Front Matter: Utilize metadata to filter entries dynamically, allowing for cleaner navigation that aligns with user needs.
- Flexible Overriding: Offers options to override generated configurations, providing the flexibility to customize navbars and sidebars beyond the default settings.
- Empty Directory Handling: Options to skip adding empty directories to the navbar and sidebar ensure a clean user interface.