前言¶
在 DSH 工作流裏,交付物經常是成批的 Markdown 或純文本說明。人工通讀時容易漏掉標題從 ## 直接跳到 ####、同級標題重複、空標題行,以及整篇沒有任何標題的「無結構」文檔。這些問題不會立刻導致構建失敗,卻會讓後續檢索、目錄生成和 Agent 按章節引用變得不可靠。
下面介紹社區插件 深鯨文檔結構(npm 包名 @deepwhale-cn/dsh-doc-outline,倉庫 feely0208/dsh-doc-outline)。它在 DSH Web 側欄提供檢查結果,並對指定目錄做批量掃描;只提示問題,不自動改文件。
這是什麼¶
深鯨文檔結構 歸類爲 DSH 社區目錄中的 工作流 插件,由維護者 feely0208 發佈,源碼託管於 GitHub。插件定位是:對 Markdown 文檔的 標題結構 做靜態檢查,覆蓋層級跳躍、重複標題、空標題,以及完全沒有標題結構的文檔。
與「寫完後憑肉眼掃一遍」相比,它把上述規則固定成可重複執行的檢查,適合在交付前或 CI 旁路里統一跑一遍。
核心功能¶
依據項目 README 與 package.json 描述,當前版本(0.1.0)覈實到的能力如下:
- 層級跳躍:標題級別不應出現不合理跳級(例如中間缺層)。
- 重複標題:識別文檔內重複的標題文本。
- 空標題:發現無有效內容的標題行。
- 無結構文檔:對沒有任何標題結構的
.md/.txt給出提示。
掃描範圍與行爲邊界(README 明確說明):
- 僅處理
.md與.txt文件。 - 只提示,不修改 源文件。
- Web 面板入口:側欄 「深鯨文檔結構」。
插件依賴 @deepwhale-cn/dsh-guard-core,面向 DSH Web 客戶端注入(platform: "web"),運行環境要求 Node >= 18,DSH >= 0.1.0-rc.6 且 < 0.3.0。許可證爲 MIT。
安裝與啓用¶
安裝命令須使用資料原文,不要自行拼接 GitHub 地址:
dsh plugin --profile web add @deepwhale-cn/dsh-doc-outline
--profile web 與包內 dsh.client.platform: "web" 一致,用於在 Web 側加載面板與客戶端邏輯。安裝前建議打開倉庫 README 與源碼,確認許可證與將要執行的檢查邏輯;插件以 當前 dsh 進程的權限 讀取你指定的輸入路徑。
典型用法¶
命令行入口爲 dsh-doc-outline(見 package.json 的 bin 字段)。README 給出的示例如下:
dsh-doc-outline --input ./交付材料
將 ./交付材料 換成實際目錄即可對其中符合條件的 Markdown / 文本做結構檢查。Web 端可在側欄打開 「深鯨文檔結構」 查看與 CLI 一致的檢查能力(具體交互以你安裝的 DSH 版本爲準)。
適用場景與注意¶
適合誰
- 需要批量驗收技術文檔、投標材料、插件說明等 Markdown 交付物的團隊。
- 希望在 DSH Web 工作流裏隨手看結構問題、又不想工具擅自改文件的開發者。
使用時注意
- 插件 不會寫回文件;修復標題仍需人工或你們自己的格式化流程。
- 非
.md/.txt不會被掃描;其它格式需先轉換或換用別的工具。 - 社區目錄頁(skillhub 條目)與 DeepSeek / 幻方無官方從屬關係;DSH 生態遵循「一切皆插件」,安裝與審計責任在使用方。
- 安裝與運行前請自行審查 GitHub 倉庫 源碼與 MIT 許可證;任何讀取本地路徑的操作都受 dsh 進程權限約束。
結尾¶
深鯨文檔結構 把 Markdown 標題的常見問題收成可重複的檢查:層級、重複、空標題與無結構文檔,CLI 與 Web 側欄並用,且保持只讀提示。若你在 DSH 裏整理文檔交付物,可先安裝 @deepwhale-cn/dsh-doc-outline,對目標目錄執行 dsh-doc-outline --input,再在側欄 「深鯨文檔結構」 對照結果。