readme comment script type code example

Example 1: markdown comment

<!-- YOUR_COMMENT_HERE -->

OR:

AT_LEAST_ONE_EMPTY_LINE_HERE

[//]: # (YOUR_COMMENT_HERE)

Example 2: comment in markdown section yaml

<!---
your comment goes here
and here
-->