bytecodealliance / bytecodealliance/component-docs
Define markdown convention/formatting rules
- 主要语言
- Rust
- 星标
- 137
- 派生
- 88
- 平均合并
- 5 天 12 小时
- 30 天内合并 PR
- 4
描述
It would be good to define our standards/expectations for markdown formatting somewhere consistently.
A good place for this would be `CONTRIBUTING.md`, but other places could work too.
In addition to introducing documentation on how markdown should be written in the repo, we should probably try and
implement some tooling that enables machines to check our output for us:
- https://github.com/hukkin/mdformat
- https://github.com/DavidAnson/markdownlint
- https://dprint.dev/overview/ w/ https://github.com/dprint/dprint-plugin-markdown
- Prettier (listed last because it's intentionally hard to configure)
I think a good PR that resolves this issue would have a comparison of the output of these tools on one of our files, along with integration of the tool into CI so that we can catch issues going forward.
贡献指南
调研方向
从 CONTRIBUTING.md 和仓库中一个具有代表性的 Markdown 文件开始。按照提议比较 mdformat、markdownlint、带有其 Markdown 插件的 dprint 和 Prettier,然后记录所选的约定,并将选定的检查集成到 CI 中,以便自动检查今后的 Markdown 输出。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- markdown
- 领域
- ci-cd, documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100