为FaShop撰写文档的环境准备

首先得有 node,并确保 node 版本是 8.10 或以上。(mac 下推荐使用 nvm 来管理 node 版本)

  1. node -v
  2. 8.1x

安装VuePress

如果没有装yarn,请通过搜索引擎 “yarn如何安装” ```bash

安装

yarn global add vuepress # 或者:npm install -g vuepress

将 VuePress 作为一个本地依赖安装

yarn add -D vuepress # 或者:npm install -D vuepress

  1. #### 写作
  2. ```bash
  3. yarn docs:dev # 或者:npm run docs:dev

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

  1. yarn docs:build # 或者:npm run docs:build
  2. # 查看编译好的网站
  3. serve -s website

图片使用

文档里的图片请使用相对路径,引入的时候如:./images/xxx.png,为了规范,请至少创建一层文件夹images