[mkdocs] - explore how to move away from multiple .html files to just one .md file per page
未关闭
还没有人认领这个 Issue。
- 主要语言
- JavaScript
- 星标
- 18.3k
- 派生
- 2k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 28
描述
We should move away from having .html files as the files that you edit to make changes to the docs. Ideally to edit the docs you'd edit a .md file and everything for a specific page is in the one .md file.
Having multiple html files for one page like we have in our existing docs, makes it challenging to create new content and edit existing content.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先检查现有文档针对每个页面是如何拆分到多个 .html 文件中的，以及这些文件是如何构建的。定义一种迁移方案，使每个页面都可以在一个 .md 文件中编辑，同时保留现有的文档内容和输出。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- markdown
- 领域
- documentation
- Issue 类型
- 重构
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 30/100