shalousun / smart-doc-group.github.io

Smart-Doc VitePress Documentation

中文文档

Project Structure

.
├─ .github                 # GitHub configuration
│  ├─ workflows            # GitHub Actions
│  │  └─ deploy.yml        # GitHub Actions deployment configuration
├─ docs                    # Project root directory
│  ├─ .vitepress           # Configuration directory
│  │  ├─ config            # Configuration files directory
│  │  │  ├─ en.ts          # English configuration file
│  │  │  ├─ index.ts       # Configuration file entry point
│  │  │  ├─ shared.ts      # Theme override configuration file
│  │  │  └─ zh.ts          # Chinese configuration file
│  ├─ en                   # English documentation                  
│  ├─ public               # Public files directory (static resources like images, fonts, etc.)
│  ├─ zh                   # Chinese documentation
│  ├─ getting-started.md
│  └─ index.md
└─ ...

Development Environment

It is recommended to use nvm to manage node versions.

pnpm installation is recommended via scoop (Windows) or brew (macOS).

Install Dependencies

pnpm install

or

pnpm i

Start Development Environment

pnpm docs:dev

Start Writing Documentation

Create the corresponding markdown files in the docs/zh or docs/en directories according to the project structure.

Build

pnpm docs:build