Install / Usage

Requirement ​

• Env: LTS Versions of Node.js (^20+)
• Package Manager: npm >= 8, pnpm >= 7

Install ​

Create a new vitepress-theme-niansi project in <dir> folder:

$ pnpm add -D vitepress-theme-niansi vitepress@next

$ npm add -D vitepress-theme-niansi vitepress@next

$ yarn add -D vitepress-theme-niansi vitepress@next

$ bun add -D vitepress-theme-niansi vitepress@next

After installation, run the following commands:

$ pnpm vitepress-theme-niansi init

$ npx vitepress-theme-niansi init

$ yarn vitepress-theme-niansi init

$ bun vitepress-theme-niansi init

Usage and Configuration ​

Please import and use the vitepress-theme-niansi theme in your configuration file:

import { defineConfig } from 'vitepress-theme-niansi'

export default defineConfig({
  // Other Configuration Items... 
  themeConfig: {
    // Other Theme Configuration Items...
  }
})

You can refer to this documentation's configuration as a configuration reference.