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
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
8ab2e5eb
Commit
8ab2e5eb
authored
9 years ago
by
squidfunk
Browse files
Options
Downloads
Patches
Plain Diff
Fixed #15: Document pygments dependency for codehilite
parent
d5883422
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
CHANGELOG
+2
-0
2 additions, 0 deletions
CHANGELOG
docs/getting-started.md
+7
-5
7 additions, 5 deletions
docs/getting-started.md
with
9 additions
and
5 deletions
CHANGELOG
+
2
−
0
View file @
8ab2e5eb
mkdocs-material-0.x.x (2016-xx-xx)
* Fixed #15: Document pygments dependency for codehilite
* Fixed #16: Favicon could not be set through mkdocs.yml
* Fixed #17: Put version into own container for styling
mkdocs-material-0.2.1 (2016-03-12)
...
...
This diff is collapsed.
Click to expand it.
docs/getting-started.md
+
7
−
5
View file @
8ab2e5eb
...
...
@@ -205,8 +205,9 @@ have to switch them on explicitly.
### CodeHilite (recommended)
This extensions adds code highlighting to fenced code blocks. It might not be
the best code highlighter, but it works without JavaScript and on the server:
This extensions uses
[
Pygments
][]
(install with
`pip install pygments`
) to add
code highlighting to fenced code blocks. It might not be the best code
highlighter, but it works without JavaScript and on the server:
```
yaml
markdown_extensions
:
...
...
@@ -220,12 +221,12 @@ further instructions
### Permalinks
In order to add
[
permalinks
][]
to the headers of your article, set the
`markdown_extensions.toc.permalink`
variable to a symbol, e.g.
`
¶
`
:
`markdown_extensions.toc.permalink`
variable to a symbol, e.g.
`
#
`
:
```
yaml
markdown_extensions
:
-
toc
:
permalink
:
'
¶
'
permalink
:
'
#
'
```
The symbol can be chosen freely, it can even be a WebFont icon.
...
...
@@ -317,7 +318,7 @@ markdown_extensions:
-
codehilite(css_class=code)
-
admonition
-
toc
:
permalink
:
'
¶
'
permalink
:
'
#
'
```
[
MkDocs
]:
http://www.mkdocs.org
...
...
@@ -326,6 +327,7 @@ markdown_extensions:
[
Google Fonts
]:
https://www.google.com/fonts
[
Roboto font
]:
https://www.google.com/fonts/specimen/Roboto
[
Markdown extensions
]:
http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
[
Pygments
]:
http://pygments.org
[
highlight.js
]:
https://highlightjs.org
[
extra
]:
http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
[
permalinks
]:
https://en.wikipedia.org/wiki/Permalink
...
...
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