本文主要讲用 gitbook 来写技术文档. 省出了写很多花哨的样式和页面的情况.
01 背景
难免有时候需要写前端的技术文档, 如果从头开始写个页面或者用个文档框架还是要花不少时间.
不如直接用 gitbook 来实现, Markdown 语法对前端同学友好. 界面也大气简洁.
Redux Gitbook
02 接入 gitbook
- sudo cnpm i gitbook -g
- gitbook init
gitbook init 可以初始化整个文档目录, 内置了 readme.md 和 summuery.md, 一个是说明, 一个是导航文档. gitbook 其实就是把所有 Markdown 连接起来, 用起来像是一个网站.
可以在这个地址体验下: https://cn.redux.js.org/docs/basics/
写好文档后 gitbook serve 在 localhost:4000 上可以看到效果. 并实时监听你的修改.
gitbook build
gitbook build 会最终将 md 文件打包到 dist 目录下.
03 部署
gitbook 提供了 docker 部署的方案. 但为了方便, 可以直接用一个 http-server 将 dist 目录作为静态服务部署到服务器就好了.
来源: http://www.jianshu.com/p/4b7675f1aae9