php之markdown文件管理工具的實作程式碼

本文主要跟大家分享php之markdown文件管理工具的實作程式碼，希望能幫助大家。

主要目標:

1.可以多人編輯

2.可以在瀏覽器中查看

3.有一個可以折疊的目錄

4.支援多層目錄

5.支援markdown

6.快, 方便

工作後一直在從事PHP開發, 從以前的大包大攬到現在的退居服務端寫接口, 當中接觸過幾個的接口文檔管理工具或系統, 簡單描述下:

1. showdoc, 功能全面而且簡潔, 有使用者,權限管理功能, 支援markdown, 支援匯出word, 有多種文件範本, 目錄支援兩層摺疊

2. confluence, 功能強大(權限管理, 郵件提醒, 全文搜尋,外掛程式管理等), 重, 收費的一個文件管理系統

3. #swagger, 需要在程式碼中寫大量的註解去配合

4. #readmine, 功能豐富類似confluence, 它的文檔是以txt保存的, 可以追溯變更, 可以全文搜索, 但是寫文檔有點痛苦, 適合任務/bug跟踪管理等

5. #gitbook, nodejs安裝, 支援markdown, 支援npm插件, 左側的可折疊的目錄樹就需要裝插件, 也可以裝搜尋插件, 目錄是單獨的markdown文件, 我使用的時候感覺從md到HTML編譯太慢(600+的文檔, 要編譯25分鐘多, 如果有增量編譯或提高編譯速度的插件還請各位賜教

解決方法:

1. 結合git就可以實現, 剛好也可以利用git的權限管理功能

2. 需要將markdown編譯成HTML檔部署到內網

3. 因為要在瀏覽器中查看, 這裡最終選擇了接入簡單, 介面清爽, 無依賴的dtree.js (不依賴jQuery)

4. 這個功能用了樹的後根序遍歷演算法實現了對多層級檔案的讀取(沒有用遞歸, 擔心寫著寫著把自己繞進去), 正好dtree.js 也支援多層目錄折疊

5. 這裡我最後選擇了segmentfault官方出的PHP編譯工具類別(因為他們已經參考優化了很多類似的PHP類別,感謝~)

6. 快的話, 編譯600多個檔案, PHP用時2s左右,可以接受, 而且支援增量編譯; 方便的話, 主要體現在目錄是自動生成的, 不需要單獨在編寫目錄

#其中遇到的問題:

增量編譯

剛開始判斷一個md檔是否需要編譯成HTML, 是拿md檔的建立時間和最後修改時間做比較進行判斷的,
但是後來發現, 一些複製來的, 重命名的文件用這個方法就不起作用.
最後使用了一個中間文件, 去記錄本次編譯的文件的時間, 再跟max(創建時間, 最後修改時間)對比判斷是否需要編譯

刪除多餘文件

後續使用過程中發現, 有些md文檔被刪除了, 但是沒有自動刪除最終編譯後的文件,
因此, 在編譯時會對md檔和最後的HTML檔坐一個差集, 刪掉那些多餘的HTML檔

整合dtree.js

#首先, dtree.js需要一定要求的json資料才能顯示目錄和進行展開和折疊的交互
還有, dtree.js字體比較小, 他的圖片,樣式,腳本文件都是相對路徑, 我這裡對路徑做了相應修改, 使之改為基於目前網域的絕對路徑, 這樣部署到不同的網域下是不用修改dtree.js程式碼的層級目錄的

組裝, 美化HTML

組裝是事先寫好HTML的頭部, 底部, 側邊欄等的HTML代碼, 然後把這些內容拼接到編譯後的內容前後, 最後再放到相應的文件夾中去
美化, 這個主要是因為segmentfault官方出的編譯工具並沒有對HTML元素(例如, table, code)添加樣式, 我在這裡找到github的相關css樣式進行了美化

支持多級目錄

這個也是耗費了我大量腦細胞寫出來的, 大學的時候寫動態哈夫曼編碼的時候寫過一遍樹的遍歷了,
本以為駕輕就熟, 誰知道折騰到夜裡3點多才最終寫好, 這個功能也算是核心組件之一了吧。

相關建議：

Vuejs使用vue-markdown 來渲染註解方法

VSCode中預覽markdown和修改預覽樣式

markdown編輯器的簡單介紹

以上是php之markdown文件管理工具的實作程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章！