# 快速上手

注意

请确保你的 Node.js 版本 >= 8.6。

# 全局安装

为了方便以后快速创建 VuePress 项目,这里推荐使用 yarn 进行全局安装:

yarn global add vuepress-creator

或者如果你只使用 npm :

npm install -g vuepress-creator

注意

部分用户在 yarn 环境下可能无法正常识别 vuepress-creator 命令,经测试,可通过命令行 yarn global bin 获取 yarn 全局安装包路径,然后添加至系统环境变量中即可解决。

# 创建项目

在命令行窗口输入以下命令开始创建项目:

vuepress-creator init myproject

其中,可以把 myproject 替换为你想要的名称。回车后,会跳出一个选项:

# 为 VuePress 选择一个主题? 默认:Default
Pick a theme for VuePress?
> Default
  AntDocs (Ant Design style)

选择完毕后,脚手架将自动进行一系列的操作,直到配置完毕。再此期间,请你耐心等待。

# 开发运行

打开已经配置完毕的项目,在命令行窗口输入以下命令:

yarn dev # 或者:npm run dev

# 生产运行

要生成静态的 HTML 文件,运行:

yarn build # 或者:npm run build

生成的静态文件会存放在 .vuepress/dist,你也可以自定义生成路径,但实际上一般不需要修改它。
这里推荐使用 VS Code 编辑器,对执行 package.json 文件内的脚本命令很友好,同时也支持编写 .md 文档。

上次更新: 2020-3-10 23:58:45