From b955abab6ea79b6552dcf1937bae58e86df4761d Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Mon, 16 Oct 2017 13:13:05 -0400 Subject: [PATCH] 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 --- docs/extensions/codehilite.md | 3 ++- docs/extensions/permalinks.md | 6 ++++-- docs/extensions/pymdown.md | 6 ++++-- docs/getting-started.md | 12 ++++++++---- 4 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/extensions/codehilite.md b/docs/extensions/codehilite.md index 195585d9d..dd4cdabf3 100644 --- a/docs/extensions/codehilite.md +++ b/docs/extensions/codehilite.md @@ -115,7 +115,8 @@ Line numbers can be added by enabling the `linenums` flag in your `mkdocs.yml`: ``` yaml markdown_extensions: - - codehilite(linenums=true) + - codehilite: + linenums:true ``` Example: diff --git a/docs/extensions/permalinks.md b/docs/extensions/permalinks.md index 3269c834d..d34475129 100644 --- a/docs/extensions/permalinks.md +++ b/docs/extensions/permalinks.md @@ -13,7 +13,8 @@ To enable permalinks, add the following to your `mkdocs.yml`: ``` yaml markdown_extensions: - - toc(permalink=true) + - toc: + permalink: true ``` 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_extensions: - - toc(permalink=Link) + - toc: + permalink: Link ``` ## Usage diff --git a/docs/extensions/pymdown.md b/docs/extensions/pymdown.md index ef66fa3fe..baa4f1481 100644 --- a/docs/extensions/pymdown.md +++ b/docs/extensions/pymdown.md @@ -21,7 +21,8 @@ package are recommended to be used together with the Material theme: ``` yaml markdown_extensions: - pymdownx.arithmatex - - pymdownx.betterem(smart_enable=all) + - pymdownx.betterem: + smart_enable: all - pymdownx.caret - pymdownx.critic - pymdownx.details @@ -32,7 +33,8 @@ markdown_extensions: - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences - - pymdownx.tasklist(custom_checkbox=true) + - pymdownx.tasklist: + custom_checkbox: true - pymdownx.tilde ``` diff --git a/docs/getting-started.md b/docs/getting-started.md index de87f95e9..35ecd8922 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -486,8 +486,10 @@ but highly recommended, so they should be switched on at all times: ``` yaml markdown_extensions: - admonition - - codehilite(guess_lang=false) - - toc(permalink=true) + - codehilite: + guess_lang: false + - toc: + permalink: true ``` For more information, see the following list of extensions supported by the @@ -554,6 +556,8 @@ google_analytics: # Extensions markdown_extensions: - admonition - - codehilite(guess_lang=false) - - toc(permalink=true) + - codehilite: + guess_lang: false + - toc: + permalink: true ```