vitepress-sidebar icon indicating copy to clipboard operation
vitepress-sidebar copied to clipboard

🔌 VitePress Sidebar is a plugin for VitePress that automatically configures and manages the sidebar of your page with simple settings.

🔌 VitePress Sidebar

awesome-vitepress license Programming Language Usage Commit Count npm downloads npm latest package github repo size Followers Stars

VitePress Sidebar is a plugin for VitePress that automatically configures and manages the sidebar of your page with simple settings.

  • ⚡️ Optimized for the latest version of VitePress
  • ⚡️ Easy to use, lots of options to customize to your liking
  • ⚡️ Lightweight bundle file size, zero dependencies
  • ⚡️ Multiple Sidebars support
  • ⚡️ Frontmatter support
  • ⚡️ TypeScript support
  • ⚡️ Customize menus for sorting, special character conversion, file and folder filters, and more

Documentation (Getting Started & All option lists)

Installing and using the package and defining all the utility methods can be found on the documentation page below: https://vitepress-sidebar.jooy2.com/getting-started

Real-world Uses

VitePress Sidebar is utilized in a variety of project environments, including my own web services.

  • To explore packages used other than: https://github.com/jooy2/vitepress-sidebar/network/dependents

Contribute

You can report issues on GitHub Issue Tracker. You can also request a pull to fix bugs and add frequently used features.

License

Copyright © 2022-2024 Jooy2 <[email protected]> Released under the MIT license.