Markdown的一些Tips

分享技术!

Posted by Andrew Zeng on June 14, 2022

不断更新Markdown使用过程中的一些Tips,供参考!

1. Markdown中的注释

参考:https://stackoverflow.com/questions/4823468/comments-in-markdown

That is:

1
2
3
[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in  the output file unless you use it in)
[comment]: <> (a reference style link.)

Or you could go further:

1
[//]: <> (This is also a comment.)

To improve platform compatibility (and to save one keystroke) it is also possible to use # (which is a legitimate hyperlink target) instead of <>:

1
[//]: # (This may be the most platform independent comment)

I use standard HTML tags, like

1
2
3
4
<!---
your comment goes here
and here
-->