Skip to content

References

Abbreviations

Use Abbreviations to include a glossary for terms. When you create an Abbrevation, a popup will appear on mouseover. To create a glossary item add the Abbrevation to the document prefixed by an asteriks (*) and enclosed by brackets ([]).

YAML is used to configure **Materials for MarkDown**.

*[YAML]: Yet Another Markup Language or YAML Ain't Markup Language (a recursive acronym).

YAML is used to configure Materials for MarkDown.

Tip

The Snippets extension can be used to implement a glossary by moving all abbreviations in a dedicated file. Add the extension to mkdocs.yml:

markdown_extensions:
  - pymdownx.snippets

Added a reference to a glossary file in each document:

Footnotes

Use Footnotes to add additional notes and references to the main text. When you create a Footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.

To create a Footnote, add a caret and an identifier inside brackets ([^1]) in the text. Subsequently, add the Footnote to the document using the same identifier followed by a colon and text ([^1]: My footnote.).

You can declare a footnote[^1] anywhere.

[^1]:
    The Footnote is displayed at the bottom of the document.

You can declare a footnote1 anywhere.

Use Links to create a reference to another document. This document can be part of the same site or refer to an external site.

To create a Link enclose the link text in brackets ([]) followed with the URL in parentheses (()), optionally with a title for the URL added in quotes to the URL (() ''). If you simply want the show the URL a shorthand notation is to enclose the URL with less-then / greater-then signs (<>).

External

The create External references include the absolute URL to the site.

Syntax Result
[Markdown Guide](https://www.markdownguide.org/) Markdown Guide
[Markdown Guide](https://www.markdownguide.org/ 'The Markdown Guide') Markdown Guide
<https://www.markdownguide.org/> https://www.markdownguide.org/

Add {target=\_blank} to the URL if the document must be opened in a new browser tab.

Syntax Result
[Markdown Guide](https://www.markdownguide.org/){target=\_blank} Markdown Guide

References can also be declared in the document and referred to in the text.

Syntax Result
[Markdown Guide][MD-Guide-URL]{target=\_blank}

[MD-Guide-URL]: https://www.markdownguide.org/ 'The Markdown Guide'		 Markdown Guide

Internal

The create Internal references include the relative URL to the document, possible with an Anchor link when available. In MKDocs the headers of a document are available as Anchor.

Syntax Result
[Anchor Link][Anchor-Link-URL]

[Anchor-Link-URL]: #links		 Anchor Link

  1. The Footnote is displayed at the bottom of the document. ↩