Skip to content

StevenJPx2/vitepress-extras

Repository files navigation

Vitepress Extras

npm version npm downloads bundle Codecov

Useful extras for Vitepress.

Usage

Install package:

# npm
npm install vitepress-extras

# yarn
yarn add vitepress-extras

# pnpm
pnpm install vitepress-extras

# bun
bun install vitepress-extras

Import:

// ESM
import { generateSidebars } from "vitepress-extras";

// CommonJS
const { generateSidebars } = require("vitepress-extras");

Functions

  • generateSidebars: will generate the sidebars for your vitepress docs.

Roadmap

  • Tests

Development

  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Made with 💛

Published under MIT License.