host.today/ht-docker-mkdocs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
38bce1bb31
ht-docker-mkdocs/docs/extensions/permalinks.md
Phil Kunz fa42015693 fix(core): update
2019-05-13 19:04:33 +02:00

866 B
Raw Blame History

Permalinks

Permalinks are a feature of the Table of Contents extension, which is part of the standard Markdown library. The extension inserts an anchor at the end of each headline, which makes it possible to directly link to a subpart of the document.

Installation

To enable permalinks, add the following to your mkdocs.yml:

markdown_extensions:
  - toc:
      permalink: true

This will add a link containing the paragraph symbol at the end of each headline (exactly like on the page you're currently viewing), which the Material theme will make appear on hover. In order to change the text of the permalink, a string can be passed, e.g.:

markdown_extensions:
  - toc:
      permalink: Link

Usage

When enabled, permalinks are inserted automatically.