Skip to content

Instantly share code, notes, and snippets.

@DavidAnson
Last active October 15, 2025 18:30
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.

Revisions

  1. DavidAnson revised this gist Mar 7, 2024. 1 changed file with 6 additions and 3 deletions.
    9 changes: 6 additions & 3 deletions common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -8,6 +8,9 @@ GitHub's parser handles some of these cases; other parsers do not.

    To catch these problems automatically:

    * [markdownlint](https://github.com/mivok/markdownlint/) for Ruby, includes CLI
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js, [interactive demo](//dlaa.me/markdownlint/)
    * [markdownlint](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint) for Visual Studio Code
    * [markdownlint](https://github.com/mivok/markdownlint) for Ruby, includes CLI
    * [markdownlint](https://github.com/DavidAnson/markdownlint) library for Node.js, [interactive web demo](https://dlaa.me/markdownlint/)
    * [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) command-line interface for Node.js
    * [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) command-line interface for Node.js
    * [markdownlint-cli2-action](https://github.com/marketplace/actions/markdownlint-cli2-action) Action for GitHub
    * [vscode-markdownlint](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint) extension for Visual Studio Code
  2. DavidAnson revised this gist Aug 27, 2022. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -4,6 +4,8 @@ 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](https://github.com/mivok/markdownlint/) for Ruby, includes CLI
  3. DavidAnson revised this gist Nov 24, 2015. 1 changed file with 3 additions and 2 deletions.
    5 changes: 3 additions & 2 deletions common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/Markdown) mistakes.
    The following snippets show some common [Markdown](https://en.wikipedia.org/wiki/Markdown) mistakes.

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

    @@ -7,4 +7,5 @@ GitHub's parser handles some of these cases; other parsers do not.
    To catch these problems automatically:

    * [markdownlint](https://github.com/mivok/markdownlint/) for Ruby, includes CLI
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js, [interactive demo](//dlaa.me/markdownlint/)
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js, [interactive demo](//dlaa.me/markdownlint/)
    * [markdownlint](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint) for Visual Studio Code
  4. DavidAnson revised this gist May 12, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -7,4 +7,4 @@ GitHub's parser handles some of these cases; other parsers do not.
    To catch these problems automatically:

    * [markdownlint](https://github.com/mivok/markdownlint/) for Ruby, includes CLI
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js, [interactive demo](//dlaa.me/markdownlint/)
  5. DavidAnson revised this gist Apr 24, 2015. 2 changed files with 9 additions and 4 deletions.
    7 changes: 6 additions & 1 deletion common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -2,4 +2,9 @@ The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/

    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.
    GitHub's parser handles some of these cases; other parsers do not.

    To catch these problems automatically:

    * [markdownlint](https://github.com/mivok/markdownlint/) for Ruby, includes CLI
    * [markdownlint](https://github.com/DavidAnson/markdownlint) for Node.js/io.js
    6 changes: 3 additions & 3 deletions inconsistent-header-style.md
    Original file line number Diff line number Diff line change
    @@ -1,14 +1,14 @@
    A

    # foolish consistency
    ## foolish consistency

    is the

    # hobgoblin #
    ## hobgoblin ##

    of

    little minds
    ============
    ------------

    *Ralph Waldo Emerson*
  6. DavidAnson revised this gist Apr 23, 2015. 1 changed file with 4 additions and 3 deletions.
    7 changes: 4 additions & 3 deletions no-blank-line-before-fence.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,5 @@
    Here is some code:
    A haiku of code
    ```
    Without a blank line before it
    ```
    Without blank lines around it
    ```
    (GitHub gets it right)
  7. DavidAnson revised this gist Apr 23, 2015. 2 changed files with 10 additions and 0 deletions.
    9 changes: 9 additions & 0 deletions no-language-for-code-fence.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,9 @@
    ```
    // Comment and "var" highlighting is only for JavaScript
    var i = 5;
    ```

    ```js
    // Much better here
    var j = 5;
    ```
    1 change: 1 addition & 0 deletions reversed-link.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1 @@
    A (reversed)[link] goes nowhere
  8. DavidAnson revised this gist Apr 23, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion inconsistent-header-style.md
    Original file line number Diff line number Diff line change
    @@ -9,6 +9,6 @@ is the
    of

    little minds
    ------------
    ============

    *Ralph Waldo Emerson*
  9. DavidAnson revised this gist Apr 23, 2015. 1 changed file with 14 additions and 0 deletions.
    14 changes: 14 additions & 0 deletions inconsistent-header-style.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,14 @@
    A

    # foolish consistency

    is the

    # hobgoblin #

    of

    little minds
    ------------

    *Ralph Waldo Emerson*
  10. DavidAnson revised this gist Apr 23, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion common-markdown-mistakes.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/Markdown) errors.
    The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/Markdown) mistakes.

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

  11. DavidAnson renamed this gist Apr 23, 2015. 1 changed file with 0 additions and 0 deletions.
    File renamed without changes.
  12. DavidAnson revised this gist Apr 23, 2015. 2 changed files with 2 additions and 2 deletions.
    2 changes: 1 addition & 1 deletion -introduction.md
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/Markdown) errors.

    Click the `Raw` button to see what the source text looks like.
    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.
    2 changes: 1 addition & 1 deletion ordered-list-numbering.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,4 @@
    1. Counting
    1. Numbering
    2. is
    4. hard.
    8. Let's go shopping.
  13. DavidAnson revised this gist Apr 23, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions ordered-list-numbering.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,4 @@
    1. Counting
    2. is
    4. hard.
    8. Let's go shopping.
  14. DavidAnson revised this gist Apr 23, 2015. 2 changed files with 6 additions and 2 deletions.
    5 changes: 5 additions & 0 deletions -introduction.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,5 @@
    The following snippets show some common [Markdown](http://en.wikipedia.org/wiki/Markdown) errors.

    Click the `Raw` button to see what the source text looks like.

    GitHub's parser handles some of these cases; other parsers do not.
    3 changes: 1 addition & 2 deletions no-blank-line-after-list.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,3 @@
    * This is a list
    * followed by
    * some text
    * followed by text
    But there is no blank line
  15. DavidAnson revised this gist Apr 22, 2015. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion inline-html.md
    Original file line number Diff line number Diff line change
    @@ -1 +1 @@
    My favorite HTML tag is the <p> tag.
    A popular HTML tag is the <p> tag.
  16. DavidAnson revised this gist Apr 22, 2015. 1 changed file with 0 additions and 4 deletions.
    4 changes: 0 additions & 4 deletions no-blank-line-before-list.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +0,0 @@
    This is text followed by a list:
    * But the two are not
    * separated by a blank
    * line
  17. DavidAnson revised this gist Apr 22, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions no-blank-line-after-list.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,4 @@
    * This is a list
    * followed by
    * some text
    But there is no blank line
  18. DavidAnson revised this gist Apr 22, 2015. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions no-blank-line-before-fence.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,4 @@
    Here is some code:
    ```
    Without a blank line before it
    ```
  19. DavidAnson revised this gist Apr 22, 2015. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions inline-html.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1 @@
    My favorite HTML tag is the <p> tag.
  20. DavidAnson created this gist Apr 22, 2015.
    4 changes: 4 additions & 0 deletions no-blank-line-before-list.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,4 @@
    This is text followed by a list:
    * But the two are not
    * separated by a blank
    * line