為什么不使用github的wiki而是使用mkdocs做文檔管理?


為什么不使用github的wiki而是使用mkdocs做文檔管理?

目前 KSFramework 是使用mkdocs來做在線文檔 而非使用github的wiki,這是為什么呢?

在windows下搭建wiki本地預覽不成熟

gollum:https://github.com/gollum/gollum

A simple, Git-powered wiki with a sweet API and local frontend.

(一個簡單的支持git wiki,提供本地預覽)

在gollum的說明文檔中提到,在windows下使用目前並不成熟,不建議在正式環境中使用

Warning: Windows support is still in the works! Many things do not work right now, and many of the tests are currently failing. Proceed at your own risk!

github wiki相關資料

安裝本地預覽工具:https://blog.csdn.net/zangxueyuan88/article/details/81115652

編輯指南:https://lpd-ios.github.io/2017/07/11/GitHub-Wiki-Introduction/

mkdocs不兼容github的wiki

因為mkdocs是完全靜態的html,而wiki是動態在server上利用markdown渲染出html的,所以無法兼容wiki。

可查看這個討論:Mkdocs-compatible wiki? #976


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM