From cb215d0da42ed7ba19ac3c878bb3d527609c62d7 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 30 Oct 2016 11:26:55 +0100 Subject: [PATCH] Added documentation for Permalinks extension [ci skip] --- docs/extensions/permalinks.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/extensions/permalinks.md b/docs/extensions/permalinks.md index e69de29bb..d7772f1b2 100644 --- a/docs/extensions/permalinks.md +++ b/docs/extensions/permalinks.md @@ -0,0 +1,31 @@ +# Permalinks + +Permalinks are a feature of the [Table of Contents][] extension, which is part +of the standard Markdown library. The extension inserts a link 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 +- 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 +- toc: + permalink: "Permalink" +``` + +## Usage + +When enabled, permalinks are inserted automatically. + +[Table of Contents]: https://pythonhosted.org/Markdown/extensions/toc.html