Skip to content

Instantly share code, notes, and snippets.

@DavidAnson
Last active September 10, 2024 04:47
Show Gist options
  • Save DavidAnson/006a6c2a2d9d7b21b025 to your computer and use it in GitHub Desktop.
Save DavidAnson/006a6c2a2d9d7b21b025 to your computer and use it in GitHub Desktop.
A few common Markdown mistakes

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:

A

foolish consistency

is the

hobgoblin

of

little minds

Ralph Waldo Emerson

A popular HTML tag is the

tag.

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

A haiku of code

Without blank lines around it

(GitHub gets it right)

// Comment and "var" highlighting is only for JavaScript
var i = 5;
// Much better here
var j = 5;
  1. Numbering
  2. is
  3. hard.
  4. Let's go shopping.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment