OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation on CodeHilite

Browse Source
This commit is contained in:
squidfunk 2017-01-09 23:55:04 +01:00
parent bfca02762d
commit 6696f09444
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/extensions/codehilite.md
View File

@ -24,6 +24,14 @@ markdown_extensions:
- codehilite - codehilite
``` ```
!!! warning "Migrating from Material 0.2.x"
In 0.2.x the [CodeHilite][1] extension was included with
`codehilite(css_class=code)` which switched the CSS class from
`.codehilite` to `.code`. The current version of the theme doesn't require
that and defines styles for the default `.codehilite` class, so the part
`css_class=code` needs to be removed.
[2]: http://pygments.org [2]: http://pygments.org
[3]: http://pygments.org/languages [3]: http://pygments.org/languages

18
docs/getting-started.md
View File

@ -299,7 +299,7 @@ section on [overriding partials][11] in the customization guide.
!!! warning "Migrating from Material 0.2.x" !!! warning "Migrating from Material 0.2.x"
In 0.2.x, localization was done within the `extra` configuration of your In 0.2.x localization was done within the `extra` configuration of your
`mkdocs.yml`. With 1.0.0 this is no longer possible as the configuration `mkdocs.yml`. With 1.0.0 this is no longer possible as the configuration
will be ignored. will be ignored.
@ -325,26 +325,18 @@ markdown_extensions:
- toc(permalink=true) - toc(permalink=true)
``` ```
!!! warning "Migrating from Material 0.2.x"
The [CodeHilite][14] extension was included with
`codehilite(css_class=code)` which switched the CSS class from
`.codehilite` to `.code`. The current version of the theme doesn't require
that and defines styles for the default `.codehilite` class, so the part
`css_class=code` needs to be removed.
For more information, see the following list of extensions supported by the For more information, see the following list of extensions supported by the
Material theme including more information regarding installation and usage: Material theme including more information regarding installation and usage:
* [Admonition][15] * [Admonition][14]
* [Codehilite][14] * [Codehilite][15]
* [Permalinks][16] * [Permalinks][16]
* [Footnotes][17] * [Footnotes][17]
* [PyMdown Extensions][18] * [PyMdown Extensions][18]
[13]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions [13]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
[14]: extensions/codehilite.md [14]: extensions/admonition.md
[15]: extensions/admonition.md [15]: extensions/codehilite.md
[16]: extensions/permalinks.md [16]: extensions/permalinks.md
[17]: extensions/footnotes.md [17]: extensions/footnotes.md
[18]: extensions/pymdown.md [18]: extensions/pymdown.md

2
mkdocs.yml
View File

@ -77,7 +77,7 @@ pages:
- Getting started: getting-started.md - Getting started: getting-started.md
- Extensions: - Extensions:
- Admonition: extensions/admonition.md - Admonition: extensions/admonition.md
- Codehilite: extensions/codehilite.md - CodeHilite: extensions/codehilite.md
- Footnotes: extensions/footnotes.md - Footnotes: extensions/footnotes.md
- Permalinks: extensions/permalinks.md - Permalinks: extensions/permalinks.md
- PyMdown: extensions/pymdown.md - PyMdown: extensions/pymdown.md