技术文档快速搭建

在我们个人进行包开发、框架开发以及公司内部进行技术文档搭建的时候，我们需要搭建具有针对性的技术文档。搭建技术文档的方案有很多，我今天介绍使用docsify的搭建方法，搭建页面效果如下：

docs下文件目录如下：

安装

使用全局安装 docsify-cli 工具非常方便的搭建项目

npm i docsify-cli -g
docsify init ./docs

配置

初始化文档后，在docs文件夹下创建

• index.html 入口文件
• README.md 会做为主页内容渲染
• .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

运行

通过运行 docsify serve 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000

docsify serve docs

使用docsify-themeable主题

引入css、js文件

在index.html文件中引入如下链接

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>

自定义Options文件配置

<script>
  window.$docsify = {
      // ...
      themeable: {
          readyTransition : true, // default
          responsiveTables: true  // default
      }
  }
</script>

自定义文件覆盖

在项目安装、主题安装之后，同样可以在docs文件下配置其他文件

• _navbar.md —— 导航markdown文件
• _sidebar.md —— 侧边栏markdown文件
• cover.md —— 主页markdown文件

在docs下创建文件夹可通过链接拼接文件/文件名的方式访问改markdown,具体更多的配置可以参考官网，

部署

最终部署，我将server运行命令封装在start.sh脚本中，使用pm2直接在服务端

docsify serve docs //start.sh脚本
pm2 start ./start.sh --watch