前言

随着时间推移，项目业务会越来越复杂，为了以后能方便查阅各个模块对应的是什么内容，我决定用vuepress在本地快速搭建一个说明文档。目前使用的vuepress版本为2.0.0-beta.67。因为之前有些文章是基于v1版本，加上有些步骤不完善，所以分享此篇助你快速搭建。
工作多年提升的是什么能力，是大局观把控的能力，不是说细节不重要，是细节是你在用到的时候去查阅即可。只有你的思路逐渐广阔，你才知道用哪些技术去解决哪些问题，定位以及调试问题的能力，这些在各行各业都是适用的。

流程

步骤一：新建文件夹并进入

mkdir vuepress-starter
cd vuepress-starter

步骤二：初始化packge.json并安装所需依赖

pnpm init
pnpm add -D vuepress@next @vuepress/client@next vue

步骤三:修改packge.json中script脚本

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

步骤四：新建docs目录，终端执行一下pnpm:docs:dev，会生成.vuepress文件夹,在该目录下新建config.js，并进行如下配置:

步骤五：新建pages以及自己的md文档。示例:

来看看最终效果:

部署

这里简单说一下，如果你想部署，你需要关注配置文件里的base参数，比如你想发布到github pages，那么需要注意:

如果你准备发布到 https://<USERNAME>.github.io/ ，你可以省略这一步，因为 base 默认就是 "/" 。

如果你准备发布到 https://<USERNAME>.github.io/<REPO>/ ，也就是说你的仓库地址是 https://github.com/<USERNAME>/<REPO> ，则将 base 设置为 "/<REPO>/"。

设置好base之后，终端执行打包 pnpm docs:build生成dist目录:

如果你想部署到自己的服务器，就把该目录放到nginx目录下，并修改nginx的conf。将index.html配置好对应的目录层级。

尾声

此文分享的目的是为了快速搭建文档为了个人使用，如果你想用其来做个人blog等需要自己再去完善。快速阅读文档的能力，清晰组织你的目录的能力，能有效编写注释的能力，维护说明文档的能力，我觉得这些远比你去闷头写业务要重要，也许你写代码的思路很清晰，但是别人并不知道，尤其是对于很多要交接你工作的人来说，很多人的心态都是我就是不写注释，就是不写文档，我只写我自己能看懂的代码，这样老板就不会裁我，每个人都有自己的想法，我改变不了别人，只能要求自己。