Skip to content

Instantly share code, notes, and snippets.

@randallreedjr

randallreedjr/MarkdownComments.md

Last active January 8, 2025 07:38
Show Gist options
  • Save randallreedjr/9dceb795ee0da848ea56f73f663b07db to your computer and use it in GitHub Desktop.
Save randallreedjr/9dceb795ee0da848ea56f73f663b07db to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. randallreedjr revised this gist Jun 20, 2019. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    There are comments here but you can't see them

    Below this
    Below this ↓

    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)
  2. randallreedjr revised this gist Jun 20, 2019. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -7,7 +7,7 @@ Below this

    ---

    And above this
    And above this ↑

    Check out the "raw" file if you don't believe me!

  3. randallreedjr revised this gist Jun 20, 2019. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -5,6 +5,8 @@ Below this
    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)

    ---

    And above this

    Check out the "raw" file if you don't believe me!
  4. randallreedjr revised this gist Jun 20, 2019. 1 changed file with 4 additions and 2 deletions.
    6 changes: 4 additions & 2 deletions MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,11 +1,13 @@
    There are comments here but you can't see them

    ---
    Below this

    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)

    ---
    And above this

    Check out the "raw" file if you don't believe me!

    Here's a codeblock to see what the comment syntax looks like
    ```
  5. randallreedjr revised this gist Jun 20, 2019. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,8 +1,10 @@
    There are comments here but you can't see them

    ---

    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)

    ---

    Here's a codeblock to see what the comment syntax looks like
  6. randallreedjr created this gist Jun 20, 2019.
    14 changes: 14 additions & 0 deletions MarkdownComments.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,14 @@
    There are comments here but you can't see them

    ---
    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)
    ---

    Here's a codeblock to see what the comment syntax looks like
    ```
    [//]: # (This syntax works like a comment, and won't appear in any output.)
    [//]: # (It’s a little bizarre, but it works with MacDown and Pandoc.)
    ```

    Source: https://alvinalexander.com/technology/markdown-comments-syntax-not-in-generated-output