Resources Comments

Comments

To future users, it is extremly helpful to explain your reasoning and to leave hints about your experiences and problems with using the resource. To let them now about the details, consider writing comments. There are different ways to achieve that, which all have their own pros and cons.

Blockquotes

This is the most visible option. In this wiki you've seen some blockquotes: They are used to highlight examples.

Hey there, I'm a blockquote.

They are easy to include into your Markdown file and easy to spot in the text. One problem is, that they can't be hidden in the auto-output. This means that e.g. the PDF of a worksheet still has them included. You can use the styles as usual, e.g. write italic in blockquote.

Here's how to write them:

> Use a *greater than* at the start of the blockquote (needs to be a new line). Leave a blank line before and after any blockquote.

> If you want to go over multiple paragraphs
>
> you need to write a line containing only a *greater than* and continue in a next line

Footnotes

You could use footnotes. They are a bit trickier to use in Markdown, but easy to spot in the text. They may be not that useful if you also want to cite literature with footnotes.

You can write them like this:

Written around 1595 or 1596 by William Shakespeare.[^1]

And at the end of the file write

[^1]: This line is taken from the *default*-archetype to demonstrate citing. Here, we use a text-only footnote instead.

You can use the styles as usual, e.g. write italic in a footnote. Note that you need to keep track of the numbers yourself. As an idea, use high numbers for commentary for fellow users, e.g. start at number 100. This way, you can cite literature starting from 1 as usual.

HTML Comments

You can use HTML Comments which won't appear in the text. This is a cleaner solution, but there needs to be a hint that you used those (team: Frontmatter? html-comments: ['Yes', 'No']). And they are a bit trickier to access. Here's how to write them:

<!-- *comment* -->