exercism / exercism/docs

markdown: explicitly forbid setext headings

未关闭
#358 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
没有语言数据
星标
52
派生
98
PR 合并指标
30 天内没有已合并 PR

描述

Exercism's markdown spec talks only about ATX headings, but doesn't quite explicitly say "don't use setext headings"
https://github.com/exercism/docs/blob/d334042e8f54ba7dd24ad215648355ff7795359a/building/markdown/markdown.md#L9-L15

It does however say:
> [MD003](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md003---header-style): Use atx style

So markdown linting in the future will enforce this.

Links:
- https://spec.commonmark.org/0.30/#atx-headings
- https://spec.commonmark.org/0.30/#setext-headings

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。