目录结构

.
├── .github (可选,GitHub 配置文件)
│   ├── workflows (GitHub 工作流配置)
│   │   └── doc.yml (可选,自动部署文档的工作流)
├── docs (文档根目录)
│   ├── .vuepress
│   │  │
│   │  ├── dist (默认的) → 构建输出目录
│   │  ├── public (可选的) → 静态资源目录
│   │  ├── styles (可选的) → 用于存放样式相关的文件
│   │  ├── config.{js,ts} (可选的) → 配置文件的入口文件
│   │  └── client.{js,ts} (可选的) → 客户端文件
│   ├── @pages (可选,自动生成的文件夹,存放分类页、标签页、归档页)
│   ├── ... 存放项目文档目录
│   └── README.md (首页)
│   │
├── deploy.sh (可选,部署命令脚本)
│
└── package.json
  • docs 文档根目录 文件夹名称请不要修改

  • docs/.vuepress 用于存放全局的配置、样式、静态资源等

  • docs/@pages 此文件夹是自动生成的,存放分类页、标签页、归档页和专题页对应的.md文件

  • docs/README.md 首页

注意

请注意 VuePress 对目录大小写敏感。