mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-01-16 23:10:42 +00:00
Add how to add footnotes in a markdown file. (#718)
It could be useful to have this information in the documentation. Co-authored-by: bgg <bgg@bombe> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/718 Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org> Reviewed-by: Robert Wolff <mahlzahn@posteo.de> Co-authored-by: bgg <bgg@noreply.codeberg.org> Co-committed-by: bgg <bgg@noreply.codeberg.org>
This commit is contained in:
parent
89c2b7a3a9
commit
10f7ef9593
2 changed files with 31 additions and 4 deletions
BIN
content/images/markdown/Footnote-example.png
Normal file
BIN
content/images/markdown/Footnote-example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 KiB |
|
|
@ -45,12 +45,12 @@ This gets rendered as
|
|||
This is **bold text**.
|
||||
|
||||
```markdown
|
||||
This is also **bold text**.
|
||||
This is also __bold text__.
|
||||
```
|
||||
|
||||
This gets rendered as
|
||||
|
||||
This is also **bold text**.
|
||||
This is also __bold text__.
|
||||
|
||||
### Italics
|
||||
|
||||
|
|
@ -62,12 +62,12 @@ to get the same effect.
|
|||
Here are a few examples.
|
||||
|
||||
```markdown
|
||||
This is _italic text_.
|
||||
This is *italic text*.
|
||||
```
|
||||
|
||||
This gets rendered as
|
||||
|
||||
This is _italic text_.
|
||||
This is *italic text*.
|
||||
|
||||
```markdown
|
||||
This is also _italic text_.
|
||||
|
|
@ -77,6 +77,32 @@ This gets rendered as
|
|||
|
||||
This is also _italic text_.
|
||||
|
||||
### Strikethrough
|
||||
|
||||
To strikethrough use `~~` around the text.
|
||||
|
||||
```markdown
|
||||
This is ~~strikethrough text~~.
|
||||
```
|
||||
|
||||
is rendered as
|
||||
|
||||
This is ~~strikethrough text~~.
|
||||
|
||||
### Footnotes
|
||||
|
||||
To add footnotes use the syntax `[^name]` inline, and define them with:<br>
|
||||
`[^name]:text.`
|
||||
|
||||
```markdown
|
||||
Text with a footnote.[^1]
|
||||
[^1]: A footnote.
|
||||
```
|
||||
is rendered as
|
||||
|
||||

|
||||
|
||||
|
||||
## Forgejo-specific formatting
|
||||
|
||||
### Emoticons
|
||||
|
|
@ -128,3 +154,4 @@ E.g.
|
|||
is rendered to:
|
||||
|
||||

|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue