Skip to content

Getting Started

Welcome to the SiteName docs. This page is placeholder content — replace it with your real docs later.

Local Development

bash
pnpm docs:dev      # start dev server (default http://localhost:5173)
pnpm docs:build    # build static site to docs/.vitepress/dist
pnpm docs:preview  # preview the built output locally

Directory Structure

  • docs/.vitepress/config.ts —— site config (i18n, nav, sidebar, brand)
  • docs/.vitepress/theme/ —— theme styles and global Vue components
  • docs/index.md —— Chinese home (landing)
  • docs/guide/ —— Chinese docs
  • docs/en/ —— English version (/en/ is the English home)

Next

Head to Vue Components to learn how to extend with custom components.

基于 VitePress + Vue 3 构建