Added guide for navigation configuration

This commit is contained in:
squidfunk
2020-07-17 13:08:27 +02:00
parent b652bdad59
commit 9cc396315c
23 changed files with 285 additions and 121 deletions

View File

@@ -1,37 +0,0 @@
---
template: overrides/main.html
---
# Permalinks
Permalinks are a feature of the [Table of Contents][1] 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 specific section
of the document.
[1]: https://python-markdown.github.io/extensions/toc/
## Configuration
Add the following lines to `mkdocs.yml`:
``` yaml
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 Material
for MkDocs will make appear on hover. In order to change the text of the
permalink, a string can be passed, e.g.:
``` yaml
markdown_extensions:
- toc:
permalink: Link
```
## Usage
When enabled, permalinks are inserted automatically.

View File

@@ -57,7 +57,7 @@ extra_javascript:
```
If you want to override the default MathJax configuration, you can do this by
adding another JavaScript file **before** the MathJax runtime which contains
adding another JavaScript file __before__ the MathJax runtime which contains
the MathJax configuration, e.g.:
``` js
@@ -130,7 +130,7 @@ Lorem ipsum dolor sit amet: $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$
### BetterEm
[BetterEm][6] improves the handling of emphasis markup (**bold** and *italic*)
[BetterEm][6] improves the handling of emphasis markup (__bold__ and _italic_)
within Markdown by providing a more sophisticated parser for better detecting
start and end tokens. Read the documentation for [usage notes][7].