在線文檔管理系統


背景

現在部門里寫的開發者文檔,是用markdown寫的,然后用vuepress部署起來,雖然有用webhhook做更新,但是文檔的更新不方便,有些折磨。

有幾個缺點:

1、編寫文檔的預覽,跟實際站點顯示的有差異。

2、更新內容需要像編寫代碼一樣,不方便。

3、新增gitbook過於麻煩。

都2022年了,還做了用戶體驗那么差的東西。

需求

基於以上缺點,我很想要可在線編輯的文檔站點。

幾點需求:

1、可在線編輯,所見即所得。

2、有項目管理和文檔管理。

3、頁面風格符合產品要求。

至於文檔編輯方式,就markdown就行,這樣方便文檔遷移。

開源項目

1、mindoc

這個除了頁面風格不大符合,其他功能還是挺符合的。

功能如下:

  • 項目管理,可以對項目進行編輯更改,成員添加等。
  • 文檔管理,添加和刪除文檔等。
  • 評論管理,可以管理文檔評論和自己發布的評論。
  • 用戶管理,添加和禁用用戶,個人資料更改等。
  • 用戶權限管理 , 實現用戶角色的變更。
  • 項目加密,可以設置項目公開狀態,私有項目需要通過Token訪問。
  • 站點配置,可開啟匿名訪問、驗證碼等。

 

未完待續


免責聲明!

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



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