Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Custom/Uncommon Markdown Features

Table of Contents

To add a TOC use one of the following

[[TOC]]

- TOC
{:toc}

1. TOC
{:toc}

You can also adjust the depth of a TOC by setting the depth

{: depth=1 }
[[TOC]]

Visible Heading

Invisible Heading

And hide headers by adding the no-toc class

{: .no_toc }
### Invisible Heading

Attributes

By default, no classes are loaded. Start TermDocs with the --md-css option to load default styles (e.g. .warning, .text-right) or with --css [file] for custom classes. (Note: this feature is disabled because it increases the starting time significantly)

Block Level Attributes

Quote with different background color

{: .warning }
> Quote with different background color

Inline Attributes

Not quite functional yet

Inline attributes can be added

Inline `attributes`{: .italic } can be added

Footnotes

Here is a footnote reference,1 and another.2

Here is a footnote reference,[^1] and another.[^longnote]

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.
    Subsequent paragraphs are indented to show that they
belong to the previous footnote.
  1. Here is the footnote. 

  2. Here’s one with multiple blocks. Subsequent paragraphs are indented to show that they belong to the previous footnote.