Registry / web-framework / vite-plugin-vitepress-auto-sidebar

vite-plugin-vitepress-auto-sidebar

library1.7.1jsnpmunverified

Vite plugin that automatically generates VitePress sidebar configuration by scanning the docs directory structure. Version 1.7.1 supports options like ignoreList, collapsed groups, title extraction from markdown files or frontmatter, and auto-updates on file changes. Active development with frequent releases. Differentiates by being a dedicated Vite plugin rather than a build-time script, with live HMR support for sidebar regeneration.

web-framework devops

npm install vite-plugin-vitepress-auto-sidebar

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-VITEPR

vite-plugin-vitepress-auto-sidebar

web-frameworkjavascriptv1.7.1

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AutoSidebar

✓ import AutoSidebar from 'vite-plugin-vitepress-auto-sidebar'

✗ const AutoSidebar = require('vite-plugin-vitepress-auto-sidebar')

ESM-only; CommonJS require will fail.

AutoSidebar (default import)

✓ import AutoSidebar from 'vite-plugin-vitepress-auto-sidebar'

✗ import { AutoSidebar } from 'vite-plugin-vitepress-auto-sidebar'

Package has a default export, not a named export.

options type

✓ import type { AutoSidebarOptions } from 'vite-plugin-vitepress-auto-sidebar'

TypeScript users can import the options interface for type checking.

Configure the plugin in VitePress config to auto-generate sidebar from /docs structure.

// .vitepress/config.ts import { defineConfig } from 'vitepress' import AutoSidebar from 'vite-plugin-vitepress-auto-sidebar' export default defineConfig({ vite: { plugins: [ AutoSidebar({ path: '/docs', ignoreList: ['public'], collapsed: false, ignoreIndexItem: true, titleFromFile: true, titleFromFileByYaml: true, scanRootMdFiles: true, deletePrefix: '' }) ] }, title: 'My Docs', description: 'Documentation site' })

Debug

Known issues

breakingYou must clear the existing sidebar object in your VitePress config or the plugin may not work properly.

fix

Remove the `sidebar` property from `themeConfig` in your config file.

affects: >=1.0.0

gotchaThe `ignoreIndexItem` option's default is `false`; if you have `index.md` files, they will appear as sidebar items unless set to `true`.

fix

Set `ignoreIndexItem: true` in plugin options.

affects: >=1.0.0

deprecatedThe option `titleFromFileByYaml` may conflict with `titleFromFile`; if both true, frontmatter title takes precedence.

fix

Use only `titleFromFile` if you want markdown-level heading; use `titleFromFileByYaml` for frontmatter. They are not mutually exclusive.

affects: >=1.3.0

gotchaIf `path` does not exist, the plugin silently fails without error. Sidebar data will not be injected.

fix

Ensure the directory specified in `path` exists relative to project root.

affects: >=1.0.0

gotchaFile changes (add/delete .md) are watched only in dev mode; manual rebuild needed in production.

fix

Restart the dev server or trigger a production rebuild after file changes.

affects: >=1.0.0

Errors

Common errors & fixes

[auto-sidebar] injected sidebar data successfully

Plugin is working correctly; no error.

fix

No action needed.

Cannot find module 'vite-plugin-vitepress-auto-sidebar'

Package not installed or incorrect import path.

fix

Run `npm install vite-plugin-vitepress-auto-sidebar` and ensure import is correct.

AutoSidebar is not a function

Using named import instead of default import.

fix

Change `import { AutoSidebar }` to `import AutoSidebar`.

TypeError: Cannot read properties of undefined (reading 'sidebar')

VitePress config missing or sidebar property not cleared.

fix

Add themeConfig with empty sidebar or remove the sidebar property.

Upgrade

Version history

1.7.1latest on npm

Audit

Dependencies

vitepressrequiredPeer dependency: plugin generates sidebar data for VitePress themeConfig.

viterequiredPeer dependency: requires Vite to function as a plugin.

Agent activity

11 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/QC2168/vite-plugin-vitepress-auto-sidebar ↗

packagehttps://www.npmjs.com/package/vite-plugin-vitepress-auto-sidebar ↗