Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mkdocs-material
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Janne Mareike Koschinski
mkdocs-material
Commits
6696f094
Commit
6696f094
authored
Jan 9, 2017
by
squidfunk
Browse files
Options
Downloads
Patches
Plain Diff
Fix documentation on CodeHilite
parent
bfca0276
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/extensions/codehilite.md
+8
-0
8 additions, 0 deletions
docs/extensions/codehilite.md
docs/getting-started.md
+5
-13
5 additions, 13 deletions
docs/getting-started.md
mkdocs.yml
+1
-1
1 addition, 1 deletion
mkdocs.yml
with
14 additions
and
14 deletions
docs/extensions/codehilite.md
+
8
−
0
View file @
6696f094
...
@@ -24,6 +24,14 @@ markdown_extensions:
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
docs/getting-started.md
+
5
−
13
View file @
6696f094
...
@@ -299,7 +299,7 @@ section on [overriding partials][11] in the customization guide.
...
@@ -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:
...
@@ -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
][
1
5
]
*
[
Admonition
][
1
4
]
*
[
Codehilite
][
1
4
]
*
[
Codehilite
][
1
5
]
*
[
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
...
...
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
1
−
1
View file @
6696f094
...
@@ -77,7 +77,7 @@ pages:
...
@@ -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
-
Code
h
ilite
:
extensions/codehilite.md
-
Code
H
ilite
:
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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment