Fix all markdownlint errors across the site#1015
Open
bbatsov wants to merge 1 commit intofsharp:mainfrom
Open
Conversation
Update the linter config to disable line-length (MD013) and heading-increment (MD001), and standardize on atx headings and fenced code blocks. Fix the remaining content issues in ~15 files: escape trailing # in headings so they aren't misdetected as atx_closed, convert indented code blocks to fenced, normalize list marker spacing, add missing image alt text, replace generic link text like "[here]" and "[(link)]" with descriptive alternatives, and a handful of other small cleanups (trailing whitespace, missing final newline, emphasis-as-heading). The linter now reports 0 errors across all 150 markdown files.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I promised a while back that I'd take care of the remaining lint issues across the site, and here it is — this PR brings us from 938 markdownlint errors down to 0.
Most of the errors (840) were MD013 (line-length), which I've simply disabled — enforcing a line length limit on content-heavy markdown files creates more churn than value. I also disabled MD001 (heading-increment), since our Jekyll layouts provide the
h1and content pages intentionally start ath2/h3.On the config side I also standardized on atx headings (no closing
#) and fenced code blocks (instead of indented), which are the modern defaults most people expect.The actual content fixes across ~15 files are all minor and non-breaking:
#in headings — headings ending inF#were misdetected as atx_closed style (e.g.### Low risk ways to use F#→### Low risk ways to use F\#)1.→1.) in the install guidesalttext to a handful of<img>tags[here]and[(link)]with something descriptive (e.g.[on GitHub],[entire analysis])teaching/research.mdThe linter now reports 0 errors across all 150 markdown files: