-
Notifications
You must be signed in to change notification settings - Fork 0
Resources Body
The body refers to the things 'you can see' in the resource (text, figures, tables, ...). It is written in Markdown, for which you can a general guide here: Markdown Guide
As an example of what is achievable with our interpreter, take a look at the en/default.md
archetype. We go through it step by step, although basic text will be skipped for a better overview.
# {{ replace .Name "-" " " | title }}
This is the title. You don't need to worry about the details here, they are used by Hugo as descriped in Using Git & the Bash. The only important remark here is that #
(note the space afterward) signifies a level 1 heading. Use only on level 1 heading, right here at the start.
*Put short description of the content here*
<!--more-->
<!-- What is written before the `<!--more--` comment is used for the summary -->
We use summaries on the webpage (and search engines use them too). You can either write a summary in the frontmatter or you can write it after the level 1 heading. Put <!--more-->
on a new line, so the webpage knows where the preview stops. (In your file, you can remove the second comment in any case.)
## A Midsummer Night's Dream
This is a level 2 heading. You can use them freely.
Written around 1595 or 1596 by William Shakespeare.[^1]
Here, we use a footnote. You need to number them manually. See at the end of the file for the actual note.
### Act I, Scene 1 {#example-id}
This is a level 3 heading. Do not skip heading levels. (E.g. don't use level 1, 2, 4). You can also see the definition of an ID, {#example-id}
. It goes inside curly braces, has a hashtag and no spaces. See below for an example usage.
Theseus
: Now, fair Hippolyta, our nuptial hour
Draws on apace; [...]
Hippolyta
: Four days will quickly steep themselves in night;
This is a Definition List. First, you write the word you want to define. In a new line, you write the definition after :
(note the space).
- **bold**
- __bold as well__
You can write bold text by using two and two asteriks *
(the prefered way). You can also use two and two underlines _
(which may cause errors in other settings).
This is also the beginning of an unnumbered list (- **bold**
), with a nested unnumbered list ( - __bold as well__
, note the spaces/tabulator).
- *italic*
- _italic as well_
You can write italic text by using one and one asteriks *
(the prefered way). You can also use one and one underlines _
(which may cause errors in other settings).
- ***bold italic***
- ___yet again___
You can write bold & italic text by using three and three asteriks *
(the prefered way). You can also use three and three underlines _
(which may cause errors in other settings). You can also mix them, e.g. __*example*__
, but we advise against that.
- ~~strikethrough~~
You can write striked through text by using two and two tilds ~
.
- `inline code`
You can write text that is supposed to be read as code by using one and one backtick `
.
- A [reference](#example-id) within the document
The is a link. Use [text](URL)
to have a blue, underlined, clickable text
in your document. We use the ID mentioned earlier to link to the section Act I, Scene 1
. You can also write your full web-address.
1. numbered
1. lists
2. work
This is the beginning of a numbered list with a nested second one.
2. lorem
- [ ] ipsum
- [x] dolor
The nested list is a to-do-list. The [ ]
become an empty box, while the [x]
are checked. This is used in the Archetypes, so you can change the space to an x when done.
You can use LaTeX style formating of math, even inline: \(U=R\cdot I\).
To start inline-math-mode, use \(
. You can start using basic LaTeX encoding. To finish the mode, use \)
. Some Markdown editors allow to use $
instead of backslash-paranthesis, but ours does not.
\[
\begin{align}
E &= m\cdot c^2 \\
&=m\cdot (\nu\cdot\lambda)^2
\underset{would~you~look~at~that!}{=} \left(\frac{h\cdot c}{\lambda}\right)
\end{align}
\]
To start a multiline math equation, start the mode by using \[
on a new line and finish with \]
on a new line.
$$
\vec{F} = \frac{\dot{\vec{p}}}{m}
$$
Alternatively, you can use $$
at the start and end of it.
```python
import numpy as np
is_it_awesome = True
```
You can write multiline code (starting and ending with three backticks on a newline) and have it colored (for common programming languages). Just write the name of the language after the first backticks, no space.
<div style="text-align: center; margin-left: auto; margin-right: auto; width: 75%;" >
| Syntax | Description | Test Text |
|:----------|:-----------:|----------------------------------:|
| Header | Title | Here's this |
| Paragraph | Text | Here's how to escape the pipe: \| |
</div>
You can write tables like this. The <div [...]
and </div>
line are to center the table, you don't need to change those. To write a table, seperate the columns by |
and start with the headings. In the next line, use hyphens to mark the line. The number of hyphens isn't important, just make it at least three. It is common to make as much as needed, so all |
symbols align. In that line, use :
to tell where to align the columns. You can then start filling the table.
You might want to use an online editor to ease all the effort.
Have fun with all these possibilities :v:
You can use smileys on the webpage, but they won't necessarily work in the auto-output.
## Literature and sources
This is an optional heading, if you want to hint at other resources or additional material. If you don't have such tips, just remove it.
[^1]: W. Shakespeare (1595 or 1596), A Midsummer Night's Dream, [Open Source Shakespeare](https://www.opensourceshakespeare.org/views/plays/play_view.php?WorkID=midsummer)
[^2]: Author (year), title, Publisher/Journal Name (doi: XXX)
Here is the second part of our footnotes. You can write text normally. We just left an example on how to cite. There will be a horizontal line drawn before the footnotes. The second footnote won't be rendered, because it's not referred to in the text.