Vuepress Theme Sidebar

Overview

Vuepress Theme Sidebar is a theme for Vuepress 2.x that automatically generates a sidebar navigation for your documentation. It extends the functionality of the official default theme by adding the ability to generate left or right sidebars based on the Markdown files or folders within your docs directory. Additionally, it moves the navigation from within the page to the right-hand side of the reading area, similar to Docusaurus.

Features

• Automatic sidebar generation: Based on the Markdown files or folders in the docs directory, the theme automatically generates a sidebar navigation.
• Left or right sidebar: You can choose whether to generate a left or right sidebar. If not specified, both sidebars will be generated.
• Folder as collapsible menu: By default, folders are displayed as collapsible menus, with the folder name serving as the name for the right-hand sidebar navigation. However, you can customize this behavior by adding a _category_.json file within the folder.

Summary

Vuepress Theme Sidebar is a theme for Vuepress 2.x that adds automatic sidebar generation functionality to your documentation. It allows you to easily navigate through your documentation with a sidebar on either the left or right side of the page. The theme also provides the option to customize the behavior of folders within the sidebar. Installation and configuration are straightforward, making it easy to integrate into your Vuepress project.