Consider using MyST
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
Issue 中没有提到任何文件或测试。先阅读链接的 MyST parser 介绍,然后定位 docs.appimage.org 的 Sphinx 配置;完成标准是支持 MyST Markdown,同时现有的 reStructuredText 仍可使用。
由索引模型根据 Issue 内容生成。
描述
Currently we are using reStructuredText for docs.appimage.org but some users (including myself) strongly prefer Markdown.
reStructuredText offers more powerful features but also has an entirely unfamiliar (at least to me) syntax, resulting in me avoiding to touch the documentation altogether.
MyST could be the solution:
The MyST-parser is a Sphinx parser for the MyST markdown language. When you use it, Sphinx will know how to parse content files that contain MyST markdown (by default, Sphinx will assume any files ending in .md are written in MyST markdown).
It allows one to use directives in Markdown.
It is even possible to use both MyST and reStructuredText.
https://myst-parser.readthedocs.io/en/latest/using/intro.html#intro-writing
- 主要语言
- HTML
- 星标
- 50
- 派生
- 46
- 平均合并
- 5 小时 11 分钟
- 30 天内合并 PR
- 2
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
AppImage/docs.appimage.org 的其他 Issue
-
linuxdeploy is also available on ARM可能已有人在做 @Korne127 于 812 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 68/100
AppImage/docs.appimage.org#98 · 2 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
AppImage/docs.appimage.org#148 ·
-
难度 2/5 半天 新手友好度 45/100
AppImage/docs.appimage.org#127 ·
-
难度 5/5 一周以上 新手友好度 25/100
AppImage/docs.appimage.org#121 ·
-
难度 5/5 一周以上 新手友好度 35/100
AppImage/docs.appimage.org#105 · 4 条评论 ·
查看 AppImage/docs.appimage.org 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 75/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 72/100
grafana/profiles-drilldown#1212 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
grafana/traces-drilldown#980 ·
维护者通常 1 天内回复
-
sync-en
难度 1/5 1 小时以内 新手友好度 75/100
维护者通常 2 天内回复