Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jooy2/vitepress-sidebar

🔌 VitePress Sidebar is a plugin for VitePress that automatically configures and manages the sidebar of your page with simple settings.
https://github.com/jooy2/vitepress-sidebar

automation generator menu menus plugin sidebar sidebar-menu vite vitepress vitepress-plugin vitepress-plugin-sidebar vitepress-theme

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/jooy2/vitepress-sidebar
Owner: jooy2
License: mit
Created: 2022-10-24T23:50:33.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-05-29T00:28:31.000Z (4 months ago)
Last Synced: 2024-05-29T14:33:10.086Z (4 months ago)
Topics: automation, generator, menu, menus, plugin, sidebar, sidebar-menu, vite, vitepress, vitepress-plugin, vitepress-plugin-sidebar, vitepress-theme
Language: TypeScript
Homepage: https://vitepress-sidebar.jooy2.com
Size: 1.57 MB
Stars: 113
Watchers: 1
Forks: 8
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-vitepress-v1 - vitepress-sidebar - Automatically configures and manages the sidebar of your page with simple settings (:electric_plug: Plugins / Community Plugins)

README

        # 🔌 VitePress Sidebar

[![awesome-vitepress](https://awesome.re/mentioned-badge.svg)](https://github.com/logicspark/awesome-vitepress-v1) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jooy2/vitepress-sidebar/blob/master/LICENSE) ![Programming Language Usage](https://img.shields.io/github/languages/top/jooy2/vitepress-sidebar) ![Commit Count](https://img.shields.io/github/commit-activity/y/jooy2/vitepress-sidebar) [![npm downloads](https://img.shields.io/npm/dm/vitepress-sidebar.svg)](https://www.npmjs.com/package/vitepress-sidebar) [![npm latest package](https://img.shields.io/npm/v/vitepress-sidebar/latest.svg)](https://www.npmjs.com/package/vitepress-sidebar) ![github repo size](https://img.shields.io/github/repo-size/jooy2/vitepress-sidebar) [![Followers](https://img.shields.io/github/followers/jooy2?style=social)](https://github.com/jooy2) ![Stars](https://img.shields.io/github/stars/jooy2/vitepress-sidebar?style=social)

**VitePress Sidebar** is a plugin for **[VitePress](https://vitepress.dev)** 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](https://vitepress.dev/reference/default-theme-sidebar#multiple-sidebars) support

- ⚡️ [Frontmatter](https://vitepress.dev/guide/frontmatter) support

- ⚡️ [TypeScript](https://www.typescriptlang.org) support

- ⚡️ Customize menus for sorting, special character conversion, file and folder filters, and more

## [Documentation (Getting Started & All option lists)](https://vitepress-sidebar.jooy2.com/guide/getting-started)

Installing and using the package and defining all the utility methods can be found on the documentation page below: https://vitepress-sidebar.jooy2.com/guide/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](https://github.com/jooy2/vitepress-sidebar/issues).

You can also request a pull to fix bugs and add frequently used features. To contribute to a project, follow these steps

1. Clone the project.

2. Create changes (features, bugfixes) in a new branch.

3. Write a test (`test/specs/apis.spec.ts`) if a new option has been added.

4. Create a documentation (`docs/`) if a new option is added.

5. Request a pull request. Include any changes or considerations in the description for a quick code review.

## License

Copyright © 2022-2024 [Jooy2](https://jooy2.com) <[[email protected]](mailto:[email protected])> Released under the MIT license.