[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