My Docs

Appearance

Getting Started ​

This guide demonstrates the features pre-configured in this template.

Code Groups with Icons ​

js
export default {
  title: 'My App',
  description: 'My app description',
}
ts
import { defineConfig } from 'vitepress'

export default defineConfig({
  title: 'My App',
  description: 'My app description',
})
bash
pnpm install
pnpm docs:dev

Mermaid Diagrams ​

Image Zoom ​

Click the image below to see the zoom effect.

Sample Image

This template comes with built-in full-text local search. Press Ctrl+K (or Cmd+K on Mac) to open the search dialog and try it now.

Math Equations (optional) ​

If you need math support, add markdown-it-mathjax3 to your dependencies and configure it in config.ts.

Customization ​

  1. Replace YOUR_REPO placeholders in config.ts and deploy.yml with your actual GitHub repo.
  2. Set up your Giscus comment configuration in GiscusComment.vue.
  3. Customize the logo by replacing docs/.vitepress/public/logo.svg.
  4. Add your own pages under the docs/ directory.