使用码云的Pages存放带树菜单的文档页面

众所周知码云的Pages功能可以部署静态网页&＃xff0c;那么我们可以把一些文档放在Pages里面方便在线查看。

如果用markdown写文档的话需要先把markdown转成html&＃xff0c;这个功能码云已经提供了在wiki里面直接可以转。 但是还需要一个左侧树状菜单功能。这个可以用其它工具来实现&＃xff0c;网上也有一个插件&＃xff0c;地址&＃xff1a;https://ruby-china.org/topics/17028

本文就是基于这个插件来实现的&＃xff0c;并且添加了代码高亮的功能。下面是一个案例&＃xff1a; easymybatis开发文档

效果图

下面就来讲解生成步骤&＃xff1a;

• Fork这个项目到自己的码云中&＃xff0c;pages-doc
• 进入到wiki写文档

• 将文档转成html

• 将html中的body内容放在page-doc的index.html中&＃xff0c;记得push到码云

• 开启Pages服务

• 开启成功后访问页面即可&＃xff0c;这里是demo页面&＃xff1a;doc-demo

需要注意的地方&＃xff1a;

• 标题层级要规范&＃xff0c;#一级&＃xff0c;##二级&＃xff0c;以此类推
• 标题可以不用数字&＃xff0c;插件会自动帮你生成&＃xff0c;在index.html中找到is_auto_number进行设置

其实只要html的标题规范&＃xff0c;任何html内容都可以放进去。