I have searched Google and SO, and don't know if SO is the place to ask this, but I was wondering if there is markup for doing annotations of some type for markdown? We do docs in markdown for our project and would like to do annotations between team members without changing the contents. Maybe I am asking this wrong, but I hope this makes sense. As of now, I am guessing there is not as I have not found an answer, and hoping someone else has found a way to do such a thing.
Thank you for any help that can be offered.
To create a footnote reference, add a caret and an identifier inside brackets ( [^1] ). Identifiers can be numbers or words, but they can't contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.
Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world's most popular markup languages. Using Markdown is different than using a WYSIWYG editor.
Markdown is an easy-to-use markup language that is used with plain text to add formatting elements (headings, bulleted lists, URLs) to plain text without the use of a formal text editor or the use of HTML tags.
Strikethroughs. In order to create a crossed-out text, use the tilde in Markdown twice in a row, followed by the respective text and then another two tildes. ~~This text is struckthrough.
Use HTML formatted comments (as scoa noted):
<!-- this is a comment -->
HTML is a part of the markdown specification:
For any markup that is not covered by Markdown’s syntax, you simply use HTML itself. There’s no need to preface it or delimit it to indicate that you’re switching from Markdown to HTML; you just use the tags.
Footnotes are not part of the offical/original markdown specification.
But some markdown flavours support [^1] / [^1]:
syntax, for example:
Some Text. [^footnote]
[^footnote]: This is a footnote.
I think
http://criticmarkup.com/
might be a solution. It offeres a special syntax for additions, deletions, changes and comments, as well as a machinery to highlight these changes.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With