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


声明:本文转载自https://my.oschina.net/u/3658366/blog/1604469,转载目的在于传递更多信息,仅供学习交流之用。如有侵权行为,请联系我,我会及时删除。

插播一条广告→2021 ByteDance字节跳动内推←各城市、各方向的岗位都有,大量招人!


众所周知码云的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内容都可以放进去。

本文发表于2018年01月09日 16:32
(c)注:本文转载自https://my.oschina.net/u/3658366/blog/1604469,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责。如有侵权行为,请联系我们,我们会及时删除.

阅读 952 讨论 0 喜欢 0

抢先体验

扫码体验
趣味小程序
文字表情生成器

闪念胶囊

你要过得好哇,这样我才能恨你啊,你要是过得不好,我都不知道该恨你还是拥抱你啊。

直抵黄龙府,与诸君痛饮尔。

那时陪伴我的人啊,你们如今在何方。

不出意外的话,我们再也不会见了,祝你前程似锦。

这世界真好,吃野东西也要留出这条命来看看

快捷链接
网站地图
提交友链
Copyright © 2016 - 2021 Cion.
All Rights Reserved.
京ICP备2021004668号-1