Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown: explicitly forbid setext headings #358

Open
ee7 opened this issue Jun 22, 2022 · 0 comments
Open

markdown: explicitly forbid setext headings #358

ee7 opened this issue Jun 22, 2022 · 0 comments

Comments

@ee7
Copy link
Member

ee7 commented Jun 22, 2022

Exercism's markdown spec talks only about ATX headings, but doesn't quite explicitly say "don't use setext headings"

## Headings
- All files must start start with a level-1 heading (`# Some heading text`).
- Level-1 headings exist purely for consuming on GitHub or equivalent.
- If the file is rendered by Exercism (e.g. displayed on the website, rendered via the CLI), this heading will be removed, and a contextual heading will be inserted.
- No heading may descend a level greater than one below the previous (e.g. `##` may only be followed by `###`, not `####`).
- Beyond the single level-1 (`#`) heading, only level-2 (`##`), level-3 (`###`) and level-4 (`####`) headings may be used.

It does however say:

MD003: Use atx style

So markdown linting in the future will enforce this.

Links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant