Getting started

Installation

• Node.js version 18 or higher
• A VitePress project
• A package manager: e.g. npm, pnpm, ...

npm

$ npm install -D @ogs-gmbh/vitepress-plugin-sidebar

pnpm

$ pnpm add -D @ogs-gmbh/vitepress-plugin-sidebar

yarn

$ yarn add -D @ogs-gmbh/vitepress-plugin-sidebar

bun

$ bun add -D @ogs-gmbh/vitepress-plugin-sidebar

Usage

Now, just import and use the sidebarPlugin inside your VitePress Site Config.

You can use the reference of Config to get a better understanding of the configuration.

index.ts

import { sidebarPlugin } from "@ogs-gmbh/vitepress-plugin-sidebar";

export default {
  themeConfig: {
    sidebar: sidebarPlugin({
      path: "./dist/vitepress-content"
    })
  }
}