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
- 星标
- 781
- 派生
- 166
- 平均合并
- 10 小时 49 分钟
- 30 天内合并 PR
- 1
环境准备
- 没有 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 于 1025 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 20/100
docsifyjs/docsify-cli#179 · 1 条评论 ·
查看 docsifyjs/docsify-cli 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 67/100
taskcluster/taskcluster#9284 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 78/100
Spomky-Labs/pwa-bundle#476 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复