markdown: explicitly forbid setext headings
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Open building/markdown/markdown.md at the referenced lines 9–15 and review how the current heading guidance is phrased. Update the specification to explicitly forbid setext headings while retaining the ATX guidance and linked references; the documentation should clearly state that only ATX headings are allowed.
Written by the indexing model from the issue text.
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: Use atx style
So markdown linting in the future will enforce this.
Links:
- Dominant language
- No language data
- Stars
- 52
- Forks
- 98
- Avg merge
- 9m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from exercism/docs
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Similar issues
-
good first issue quality
Difficulty 1/5 Under an hour Newbie friendliness 88/100
StudentSuite/awesome-student-resources#553 ·
Maintainers usually reply within 1 day
-
content good first issue
Difficulty 1/5 Under an hour Newbie friendliness 82/100
StudentSuite/awesome-skills-plugins-for-students#297 ·
Maintainers usually reply within 1 day
-
ready-for-agent wayfinder:task
Difficulty 2/5 Half a day Newbie friendliness 68/100
openaddr/dafung-web#401 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 62/100