mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-12-16 14:00:13 +01:00
Add test file for GitHub footnote syntax (closes #370).
This commit is contained in:
parent
02afeb5bc0
commit
54369a00e6
1 changed files with 20 additions and 0 deletions
20
test/github-footnote-syntax.md
Normal file
20
test/github-footnote-syntax.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# GitHub Footnote Syntax
|
||||||
|
|
||||||
|
> Example from <https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes>
|
||||||
|
|
||||||
|
Here is a simple footnote[^1].
|
||||||
|
|
||||||
|
A footnote can also have multiple lines[^2].
|
||||||
|
|
||||||
|
You can also use words, to fit your writing style more closely[^note].
|
||||||
|
|
||||||
|
[^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 render with numbers instead of the text but allow easier identification and linking.
|
||||||
|
This footnote also has been made with a different syntax using 4 spaces for new lines.
|
||||||
|
|
||||||
|
<!-- markdownlint-configure-file {
|
||||||
|
"MD013": false
|
||||||
|
} -->
|
||||||
Loading…
Add table
Add a link
Reference in a new issue