Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Annotations in markdown

Tags:

markdown

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.

like image 511
pertrai1 Avatar asked Apr 24 '15 16:04

pertrai1


People also ask

How do you add a footnote in Markdown?

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.

What is Markdown notes?

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.

Can I use HTML tags in Markdown?

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.

What is strikethrough in Markdown?

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.


2 Answers

For comments:

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.

For footnotes:

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.
like image 141
yonojoy Avatar answered Oct 20 '22 18:10

yonojoy


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.

like image 44
cknoll Avatar answered Oct 20 '22 18:10

cknoll