使用碼雲的Pages存放帶樹菜單的文檔頁面

衆所周知碼雲的Pages功能能夠部署靜態網頁,那麼咱們能夠把一些文檔放在Pages裏面方便在線查看。html

若是用markdown寫文檔的話須要先把markdown轉成html,這個功能碼雲已經提供了在wiki裏面直接能夠轉。 可是還須要一個左側樹狀菜單功能。這個能夠用其它工具來實現,網上也有一個插件,地址:https://ruby-china.org/topics/17028git

本文就是基於這個插件來實現的,而且添加了代碼高亮的功能。下面是一個案例: easymybatis開發文檔ruby

效果圖markdown

截圖

下面就來說解生成步驟:mybatis

  • Fork這個項目到本身的碼雲中,pages-doc
  • 進入到wiki寫文檔

輸入圖片說明

  • 將文檔轉成html

輸入圖片說明

  • 將html中的body內容放在page-doc的index.html中,記得push到碼雲

輸入圖片說明

  • 開啓Pages服務

輸入圖片說明

  • 開啓成功後訪問頁面便可,這裏是demo頁面:doc-demo

輸入圖片說明


須要注意的地方:工具

  • 標題層級要規範,#一級,##二級,以此類推
  • 標題能夠不用數字,插件會自動幫你生成,在index.html中找到is_auto_number進行設置

其實只要html的標題規範,任何html內容均可以放進去。插件

相關文章
相關標籤/搜索