众所周知码云的Pages功能可以部署静态网页,那么我们可以把一些文档放在Pages里面方便在线查看。
如果用markdown写文档的话需要先把markdown转成html,这个功能码云已经提供了在wiki里面直接可以转。 但是还需要一个左侧树状菜单功能。这个可以用其它工具来实现,网上也有一个插件,地址:https://ruby-china.org/topics/17028
本文就是基于这个插件来实现的,并且添加了代码高亮的功能。下面是一个案例: easymybatis开发文档
效果图
下面就来讲解生成步骤:
- Fork这个项目到自己的码云中,pages-doc
- 进入到wiki写文档
- 将文档转成html
- 将html中的body内容放在page-doc的index.html中,记得push到码云
- 开启Pages服务
- 开启成功后访问页面即可,这里是demo页面:doc-demo
需要注意的地方:
- 标题层级要规范,#一级,##二级,以此类推
- 标题可以不用数字,插件会自动帮你生成,在index.html中找到is_auto_number进行设置
其实只要html的标题规范,任何html内容都可以放进去。