Skip to content

Instantly share code, notes, and snippets.

@eseceve

eseceve/MarkdownComments.md

Forked from randallreedjr/MarkdownComments.md
Created April 5, 2022 22:31
Show Gist options
  • Save eseceve/c36ac7b7313be2b3409e4f882c22350a to your computer and use it in GitHub Desktop.
Save eseceve/c36ac7b7313be2b3409e4f882c22350a to your computer and use it in GitHub Desktop.
Download ZIP
How to add comments to Markdown
Raw
MarkdownComments.md

There are comments here but you can't see them

Below this ↓

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

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

[//]: # (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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment