jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Improve docs about footnotes

Browse Source
This commit is contained in:
Andre_601
2021-10-07 21:15:19 +02:00
committed by GitHub
parent e89a1d1b77
commit 1da9b6496e
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
content/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View File

@@ -269,12 +269,27 @@ You can add footnotes to your content by using this bracket syntax:
``` ```
Here is a simple footnote[^1]. Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
Finally, can you also use names as links, to fit your writing style more closely[^note].
[^1]: My reference. [^1]: My reference.
[^2]: Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines.
[^note]:
Named footnotes will still show with numbers instead of the text, but they allow easier identification and linking.
This footnote also has been made with a different syntax using 4 spaces for new lines.
``` ```
The footnote will render like this: The footnote will render like this:
![Rendered footnote](/assets/images/site/rendered-footnote.png) ![Rendered footnote](/assets/images/site/rendered-footnote.png)
{% tip %}
The position of a footnote does not influence where it will be shown.
This means that you can put a footnote right next to the refernce and it will still render at the bottom of the file.
{% endtip %}
{% endif %} {% endif %}
## Hiding content with comments ## Hiding content with comments