mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-02-23 22:15:03 +00:00
Docs: Add footnotes extension
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
parent
60f73a5c84
commit
c4e5ffbe7a
2 changed files with 7 additions and 8 deletions
|
@ -1,8 +1,8 @@
|
||||||
# HedgeDoc Flavored Markdown
|
# HedgeDoc Flavored Markdown
|
||||||
|
|
||||||
HedgeDoc mostly follows the [CommonMark][commonmark] standard. It shares some extensions with the [GFM][gfm] standard, but for historical reasons HedgeDoc does support not exactly GFM, but a bit more in places (and a bit less in other places).
|
HedgeDoc has its own markdown dialect which supports many features from [CommonMark][commonmark] and [Github Flavored Markdown][gfm]. It also adds some new extensions and is missing some.
|
||||||
|
|
||||||
These tables will tell you what exactly we support in HedgeDoc 1.x (HFM 1) and HedgeDoc 2 (HFM 2).
|
These tables tell you what exactly we support in HedgeDoc 1.x (HFM 1) and HedgeDoc 2 (HFM 2).
|
||||||
|
|
||||||
|
|
||||||
## Typography
|
## Typography
|
||||||
|
@ -39,9 +39,9 @@ These tables will tell you what exactly we support in HedgeDoc 1.x (HFM 1) and H
|
||||||
| [ForkAwesome][fa] | ☑️ with `<i class='fa'>` | ☑️ with shortcodes | | |
|
| [ForkAwesome][fa] | ☑️ with `<i class='fa'>` | ☑️ with shortcodes | | |
|
||||||
| LaTeX | ☑️[^mj] | ☑️[^kt] | | |
|
| LaTeX | ☑️[^mj] | ☑️[^kt] | | |
|
||||||
|
|
||||||
[^highlight]: Code-blocks with a given language are rendered with syntax-highlighting for the code.
|
[^highlight]: Code blocks with a given language are rendered using syntax highlighting.
|
||||||
[^extra-code]: Several special "language" keywords can be used for rendering diagrams, charts, etc.
|
[^extra-code]: Several special "language" keywords can be used for rendering diagrams, charts, etc.
|
||||||
[^in-bq-list]: Use of these tags is only supported within blockquotes or (un)ordered lists.
|
[^in-bq-list]: Use of these tags is only supported within blockquotes and (un)ordered lists.
|
||||||
[^mj]: LaTeX is rendered with [MathJax][mathjax].
|
[^mj]: LaTeX is rendered with [MathJax][mathjax].
|
||||||
[^kt]: LaTeX is rendered with [KaTeX][katex].
|
[^kt]: LaTeX is rendered with [KaTeX][katex].
|
||||||
|
|
||||||
|
@ -70,9 +70,7 @@ These tables will tell you what exactly we support in HedgeDoc 1.x (HFM 1) and H
|
||||||
| Alerts | ☑️ | ☑️ | | |
|
| Alerts | ☑️ | ☑️ | | |
|
||||||
|
|
||||||
## Embeddings
|
## Embeddings
|
||||||
HFM1 included support for certain embeddings of external content. These were defined in markdown by the uncommon `{%keyword parameter %}` syntax.
|
HFM 1 includes support for certain embeddings of external content by using the `{%keyword parameter %}` syntax. To increase the readability of the markdown code we decided that HFM 2 should just use plain links if possible.
|
||||||
|
|
||||||
Instead of this uncommon syntax, HFM2 uses just plain links to external content and creates embeddings for supported providers.
|
|
||||||
|
|
||||||
| Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|
| Feature | HFM 1 | HFM 2 | CommonMark | GFM |
|
||||||
|--------------------------|:-----:|:------------------:|:----------:|:---:|
|
|--------------------------|:-----:|:------------------:|:----------:|:---:|
|
||||||
|
@ -83,7 +81,7 @@ Instead of this uncommon syntax, HFM2 uses just plain links to external content
|
||||||
| [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | ☑️ | removed | | |
|
| [Speakerdeck][speakerdeck] (`{%speakerdeck ... %}`) | ☑️ | removed | | |
|
||||||
| [GitHub Gist][gist] (`{%gist ... %}`) | ☑️ | with plain link[^embed] | | |
|
| [GitHub Gist][gist] (`{%gist ... %}`) | ☑️ | with plain link[^embed] | | |
|
||||||
|
|
||||||
[^embed]: The special syntax is deprecated but will continue to work. However a plain link to the content will generate the same embedding and is preferred.
|
[^embed]: The special syntax from HFM 1 is deprecated, but will still work in HFM 2. However, a plain link to the content should be used.
|
||||||
|
|
||||||
## HTML
|
## HTML
|
||||||
Besides the basic HTML typography elements (`<p>`, `<a>`, `<b>`, `<ins>`, `<del>`) the following more special HTML elements are supported by some specification.
|
Besides the basic HTML typography elements (`<p>`, `<a>`, `<b>`, `<ins>`, `<del>`) the following more special HTML elements are supported by some specification.
|
||||||
|
|
|
@ -21,6 +21,7 @@ markdown_extensions:
|
||||||
permalink: true
|
permalink: true
|
||||||
- admonition
|
- admonition
|
||||||
- attr_list
|
- attr_list
|
||||||
|
- footnotes
|
||||||
theme:
|
theme:
|
||||||
name: 'material'
|
name: 'material'
|
||||||
language: en
|
language: en
|
||||||
|
|
Loading…
Reference in a new issue