freeCodeCamp / freeCodeCamp/devdocs
markdown export
- 主要语言
- Ruby
- 星标
- 39.5k
- 派生
- 2.6k
- 平均合并
- 4 天 32 分钟
- 30 天内合并 PR
- 13
描述
Couldn't sort out how to add something to Trello, adding here.
# Feature request
Markdown export to existing docs (where possible).
## Summary
The idea would be to show a markdown version of a page by using the ".md" extension to url's. This would be an alternative to the HTML view.
Devdocs already has simplified views of documentation, adding an option to view documentation or export documentation in markdown view would add some additional utility. Rather than depending on a conversion from html to markdown, especially in case where a document was originally in markdown.
This would also enable a potential AI integration, where markdown is preferred.
## Examples
I came across another service having the feature: https://www.mintlify.com/docs/ai/markdown-export
贡献指南
调研方向
该 issue 没有指出任何文件、测试或代码入口点。首先跟踪现有文档页面如何通过其 HTML URL 提供服务,然后确定在原始 Markdown 可用时,.md URL 如何公开它。完成内容应包括为现有文档定义 Markdown 导出行为,并覆盖相关的页面类型。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- markdown
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100