# @vitepress-custom/vitepress-plugin-sidebar

> Automatic generate the sidebar based on the file directory

Latest version **0.0.8** (published 2023-03-24) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @vitepress-custom/vitepress-plugin-sidebar
pnpm add @vitepress-custom/vitepress-plugin-sidebar
yarn add @vitepress-custom/vitepress-plugin-sidebar
bun add @vitepress-custom/vitepress-plugin-sidebar
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2023-03-24 |
| First published | 2022-11-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | huyikai |
| Maintainers | huyikai |
| Keywords | vite, vitepress, vitepress-custom, vitepress-plugin, vitepress-plugin-sidebar |

## Links

- npm: https://www.npmjs.com/package/@vitepress-custom/vitepress-plugin-sidebar
- Repository: https://github.com/vitepress-custom/vitepress-custom
- Issues: https://github.com/vitepress-custom/vitepress-custom/issues
- npm.io page: https://npm.io/package/@vitepress-custom/vitepress-plugin-sidebar

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2023-03-24
- 0.0.7 — 2022-12-06
- 0.0.6 — 2022-12-06
- 0.0.5 — 2022-11-29
- 0.0.4 — 2022-11-24
- 0.0.3 — 2022-11-22
- 0.0.2 — 2022-11-10
- 0.0.1 — 2022-11-10

## README

# vitepress-plugin-sidebar

## Brief

Automatic generate the navigation bar based on the file directory

## Dependence

Need dependence on `vitepress-plugin-fetch-docs` library. `vitepress-plugin-fetch-docs ` used to get all documents.

## Usage

```shell
npm install vitepress-plugin-fetch-docs vitepress-plugin-sidebar
```

```js
// docs/.vitepress/config.js
import docsData from 'vitepress-plugin-fetch-docs' // return promise
import sidebar from 'vitepress-plugin-sidebar'
async ()=>{
  let docs = await docsData()
  themeConfig:{
    // Pass docs as parameter to the nav method
    sidebar: sidebar(docs)
  }
}
```

---
_Source: https://npm.io/package/@vitepress-custom/vitepress-plugin-sidebar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._