指南说明

内置命令

创建项目

vuepress-creator init project

快速创建默认模板

vuepress-creator def project

快速创建 AntDocs 主题模板

vuepress-creator ads project

检测最新版本

vuepress-creator upgrade

更新最新模板

vuepress-creator upgrade -t

注意

当你的脚手架版本太旧时，更新模板可能引起兼容性问题，所以进行此操作前请到官方确认最新版本的脚手架，然后升级到可兼容的脚手架版本。

查看可用命令

vuepress-creator -h

目录结构

用 VuePress-Creator 脚手架生成的项目，默认目录结构如下：

project
├─ package.json
├─ .gitignore
├─ deploy.sh
├─ docs
│  ├─ .vuepress
│  │  ├─ config.js
│  │  ├─ config
│  │  │  ├─ nav.js
│  │  │  └─ sidebar.js
│  │  ├─ public
│  │  │  └─ assets
│  │  │     └─ logo.png
│  │  └─ styles
│  │     ├─ index.styl
│  │     └─ palette.styl
│  ├─ category
│  │  ├─ README.md
│  │  ├─ article-1.md
│  │  ├─ article-2.md
│  │  └─ sidebar_contents.js
│  └─ README.md

• docs/.vuepress: 用于存放全局的配置、组件、静态资源等。
• docs/.vuepress/config.js: 配置文件的入口文件，也可以是 YML 或 toml。
• docs/.vuepress/config/nav.js: 用于管理导航菜单的总集合。
• docs/.vuepress/config/sidebar.js: 用于管理侧边栏目录的总集合。
• docs/.vuepress/public: 静态资源目录。
• docs/.vuepress/styles: 用于存放样式相关的文件。
• docs/.vuepress/styles/index.styl: 全局样式文件，将会覆盖先前样式。更多请参考：index.styl
• docs/.vuepress/styles/palette.styl: 用于重写默认颜色常量，或者设置新的 stylus 颜色常量。更多请参考：palette-styl
• docs/category: 自定义目录，可自己命名一个目录用于归档管理 .md 文件。
• docs/category/sidebar_contents.js: 用于管理侧边栏目录的子集合，每添加一篇文档，需要向此文件写入 .md 文件名称，以便于 VuePress 侧边栏索引。
• docs/category/README.md: 常规 .md 文档，推荐添加该文件，以保证路由导航正常。
• docs/category/article-1.md: 常规 .md 文档，通常就是你写作的每一篇文章。
• docs/README.md: 首页基本配置。
• deploy.sh: 项目部署文件，更多请参考：deploy