exercism / exercism/docs

markdown: explicitly forbid setext headings

Aperta
#358 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Nessun dato sulla lingua
Stelle
52
Fork
98
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.