vuepress介绍

一直很羡慕那些好看有简介的技术文档，然后很好奇他们使用的产品，前段时间了解了一下，原来很多是用vuepress生成的，看了一下vuepress的官网，果然是简洁实用。

vuepress的官网的一句话介绍：

VuePress：Vue驱动的静态网站生成器

vuepress官网列出的最重要的三大特点：

1. 简洁至上：以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
2. Vue驱动：享受 Vue + webpack 的开发体验，可以在 Markdown 中使用 Vue 组件，又可以使用 Vue 来开发自定义主题。
3. 高性能：VuePress 会为每个页面预渲染生成静态的 HTML，同时，每个页面被加载的时候，将作为 SPA 运行。

使用确实如官网说的一样，非常简单，几步简单搞定：

1. 创建目录并用你喜欢的包管理器初始化项目（我这里就用npm）

   #mkdir project-docs && cd project-docs
   #npm init

2. 将VuePress安装为本地依赖（不推荐全局安装）

   #npm install -D vuepress

3. 在package.json中添加一些scripts（可选），主要是启动和打包脚本，如下：

   {
     "scripts": {
       "docs:dev": "vuepress dev docs",
       "docs:build": "vuepress build docs"
     }
   }

4. 在你的项目目录下（我的是project-docs）创建docs目录，并写下你的markdown文档（一般默认写一篇README.md）

5. 本地启动服务器

   #npm run docs:dev

   或者如果你没有在第3步添加scripts的话，用下面的命令：

   #vuepress dev docs 

现在，你的文档网站就已经搭建完成了，当然，配合devops，你可以在提交文档后启动构建并发布至生产服务器。

其实生产服务器你也完全没必要，直接发布至阿里云、腾讯云、或七牛云的对象存储，使用CDN加速，配置自定义域名和HTTPS证书，一个完美的高性能官方文档就完成了。