Skip to content

Commit e24ceb0

Browse files
committed
Closes #1972, update Markdown documentation
1 parent 76b375b commit e24ceb0

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

_pages/markdown.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ The default delimiters of `$$...$$` and `\\[...\\]` are supported for displayed
5454

5555
## Markdown guide
5656

57+
Academic Pages uses [kramdown](https://kramdown.gettalong.org/index.html) for Markdown rendering, which has some differences from other Markdown implementations such as GitHub's. In addition to this guide, please see the [kramdown Syntax page](https://kramdown.gettalong.org/syntax.html) for full documentation.
58+
5759
### Header three
5860

5961
#### Header four
@@ -141,9 +143,32 @@ Make any link standout more when applying the `.btn` class.
141143

142144
## Notices
143145

144-
**Watch out!** You can also add notices by appending `{: .notice}` to a paragraph.
146+
Basic notices or call-outs are supported using the following syntax:
147+
148+
```markdown
149+
**Watch out!** You can also add notices by appending `{: .notice}` to the line following paragraph.
150+
{: .notice}
151+
```
152+
153+
which wil render as:
154+
155+
**Watch out!** You can also add notices by appending `{: .notice}` to the line following paragraph.
145156
{: .notice}
146157

158+
### Footnotes
159+
160+
Footnotes can be useful for clarifying points in the text, or citing information.[^1] Markdown support numeric footnotes, as well as text as long as the values are unique.[^note]
161+
162+
```markdown
163+
This is the regular text.[^1] This is more regular text.[^note]
164+
165+
[^1]: This is the footnote itself.
166+
[^note]: This is another footnote.
167+
```
168+
169+
[^1]: Such as this footnote.
170+
[^note]: When using text for footnotes markers, no spaces are permitted in the name.
171+
147172
## HTML Tags
148173

149174
### Address Tag

0 commit comments

Comments
 (0)