exercism / exercism/docs

markdown: explicitly forbid setext headings

Open
#358 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
52
Forks
98
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.