A few common Markdown mistakes

common-markdown-mistakes.md

The following snippets show some common Markdown mistakes.

Click the Raw button to see the source text and understand the author's intent.

GitHub's parser handles some of these cases; other parsers do not.

To catch these problems automatically:

• markdownlint for Ruby, includes CLI
• markdownlint library for Node.js, interactive web demo
• markdownlint-cli command-line interface for Node.js
• markdownlint-cli2 command-line interface for Node.js
• markdownlint-cli2-action Action for GitHub
• vscode-markdownlint extension for Visual Studio Code

inconsistent-header-style.md

A

foolish consistency

is the

hobgoblin

of

little minds

Ralph Waldo Emerson

inline-html.md

A popular HTML tag is the

tag.

no-blank-line-after-list.md

• This is a list
• followed by text But there is no blank line

no-blank-line-before-fence.md

A haiku of code

Without blank lines around it

(GitHub gets it right)

no-language-for-code-fence.md

// Comment and "var" highlighting is only for JavaScript
var i = 5;

// Much better here
var j = 5;

ordered-list-numbering.md

1. Numbering
2. is
3. hard.
4. Let's go shopping.

reversed-link.md

A (reversed)[link] goes nowhere