Load markdown from external sources
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- javascript, nodejs
- 領域
- cli, documentation
研究方向
首先檢視 docsify-cli 目前如何掃描目錄，以及建立 Markdown 連結和 URL 路徑。定義外部 README.md 和 baseUrl 對映的行為，包括用於開發和測試的本機覆寫。設定的外部儲存庫能夠出現在已發佈文件的導覽中，且本機對映能如預期運作，即表示完成。
由索引模型根據 Issue 內容生成。
描述
I plan on using docsify for repo docs. One of the requirements I have is to have one repo link out to each repo's docs index file (README.md). This main repo will be the org-wide repo with a table of contents of all other documentation as well as organization/high-level documentation. The goal is to publish this org-wide docs repo and have it be the primary knowledge source for the organization which would include each repo's documentation on that website.
In order to do this, it would make sense if I can link to other external README.md files by URL. Right now docsify reads the directory to create table of contents and URL paths. Could it also grep (using ripgrep for fast file search) for all markdown links and source paths/pages from external? One could configure a baseUrl map so it only looks for links including a baseUrl in the map. The baseUrl table could allow for developers to map baseUrls to some overrides for local development and testing with the locally cloned repos.
- 主要語言
- JavaScript
- 星號
- 780
- 分支
- 167
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
docsifyjs/docsify-cli 的其他 Issue
-
難度 4/5 3-5 天 新手友好度 45/100
docsifyjs/docsify-cli#253 ·
-
enhancement
難度 3/5 1-2 天 新手友好度 35/100
docsifyjs/docsify-cli#193 ·
-
難度 1/5 1 小時以內 新手友好度 55/100
docsifyjs/docsify-cli#191 · 2 則留言 ·
-
難度 3/5 1-2 天 新手友好度 35/100
docsifyjs/docsify-cli#188 ·
-
I would like to know why generating multi-level directories is not supported可能已有人在做 @theMyth333 於 1026 天前認領。 未關閉
難度 3/5 1-2 天 新手友好度 20/100
docsifyjs/docsify-cli#179 · 1 則留言 ·
查看 docsifyjs/docsify-cli 的全部 Issue
相似的 Issue
-
documentation
難度 2/5 1-3 小時 新手友好度 78/100
PhyberApex/slds-json-schema-renderer#372 ·
維護者通常 1 天內回覆
-
usage: a custom provider's balance meters ("…%" in the balance path) ignore the Left/Used switch未關閉
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
[BUG] rag: sentence content can cross the reported sentence boundaries可能已有人在做 @LJK-ikun 今天認領。 未關閉bug
難度 2/5 1-3 小時 新手友好度 75/100
維護者通常 1 天內回覆
-
enhancement
難度 2/5 1-3 小時 新手友好度 68/100
ericcornelissen/depreman#591 ·
維護者通常 1 天內回覆
-
bug/1-unconfirmed kind/bug
難度 2/5 1-3 小時 新手友好度 84/100
維護者通常 1 天內回覆