mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Removed deprecated Markdown config format in docs
* Remove deprecated Markdown config format in docs. Support for including Markdown extension configs in the extension name has been [deprecated][1] and will not work in any future released of Python-Markdown. MkDocs has offered full support for defining extension configs [since version 0.13][2] and everyone should be using that format. [1]: https://pythonhosted.org/Markdown/release-2.6.html#extension-configuration-as-part-of-extension-name-deprecated [2]: http://www.mkdocs.org/about/release-notes/#other-changes-and-additions-to-version-0130 * Update codehilite Markdown config * Update TOC Markdown configs * Update pymdown Markdown configs
This commit is contained in:
parent
2e728cc9f6
commit
b955abab6e
@ -115,7 +115,8 @@ Line numbers can be added by enabling the `linenums` flag in your `mkdocs.yml`:
|
|||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- codehilite(linenums=true)
|
- codehilite:
|
||||||
|
linenums:true
|
||||||
```
|
```
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
@ -13,7 +13,8 @@ To enable permalinks, add the following to your `mkdocs.yml`:
|
|||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- toc(permalink=true)
|
- toc:
|
||||||
|
permalink: true
|
||||||
```
|
```
|
||||||
|
|
||||||
This will add a link containing the paragraph symbol `¶` at the end of each
|
This will add a link containing the paragraph symbol `¶` at the end of each
|
||||||
@ -23,7 +24,8 @@ permalink, a string can be passed, e.g.:
|
|||||||
|
|
||||||
``` markdown
|
``` markdown
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- toc(permalink=Link)
|
- toc:
|
||||||
|
permalink: Link
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -21,7 +21,8 @@ package are recommended to be used together with the Material theme:
|
|||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- pymdownx.arithmatex
|
- pymdownx.arithmatex
|
||||||
- pymdownx.betterem(smart_enable=all)
|
- pymdownx.betterem:
|
||||||
|
smart_enable: all
|
||||||
- pymdownx.caret
|
- pymdownx.caret
|
||||||
- pymdownx.critic
|
- pymdownx.critic
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
@ -32,7 +33,8 @@ markdown_extensions:
|
|||||||
- pymdownx.mark
|
- pymdownx.mark
|
||||||
- pymdownx.smartsymbols
|
- pymdownx.smartsymbols
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- pymdownx.tasklist(custom_checkbox=true)
|
- pymdownx.tasklist:
|
||||||
|
custom_checkbox: true
|
||||||
- pymdownx.tilde
|
- pymdownx.tilde
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -486,8 +486,10 @@ but highly recommended, so they should be switched on at all times:
|
|||||||
``` yaml
|
``` yaml
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
- codehilite(guess_lang=false)
|
- codehilite:
|
||||||
- toc(permalink=true)
|
guess_lang: false
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, see the following list of extensions supported by the
|
For more information, see the following list of extensions supported by the
|
||||||
@ -554,6 +556,8 @@ google_analytics:
|
|||||||
# Extensions
|
# Extensions
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
- codehilite(guess_lang=false)
|
- codehilite:
|
||||||
- toc(permalink=true)
|
guess_lang: false
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user