From 8ab2e5eb2a39c413003e96fce114691442e8eaff Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 17 Mar 2016 17:15:11 +0100 Subject: [PATCH] Fixed #15: Document pygments dependency for codehilite --- CHANGELOG | 2 ++ docs/getting-started.md | 12 +++++++----- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 96b88ea08..7b1b0a487 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,8 @@ 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) diff --git a/docs/getting-started.md b/docs/getting-started.md index cf6cd16f4..8360be1d7 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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