diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/extensions/code_hilite.txt | 11 | ||||
| -rw-r--r-- | docs/release-2.6.txt | 12 |
2 files changed, 22 insertions, 1 deletions
diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt index c775df7..92f8c12 100644 --- a/docs/extensions/code_hilite.txt +++ b/docs/extensions/code_hilite.txt @@ -31,7 +31,7 @@ language. When that fails, the code block will display as un-highlighted code. [documentation]: http://pygments.org/docs !!! Note - The css and/or javascript is not included as part of this extension + The css and/or JavaScript is not included as part of this extension but must be provided by the end user. The Pygments project provides default css styles which you may find to be a useful starting point. @@ -165,3 +165,12 @@ The following options are provided to configure the output: * **`noclasses`**: Use inline styles instead of CSS classes. Defaults to `False`. + +* **`use_pygments`**: + Defaults to `True`. Set to `False` to disable the use of Pygments. + If a language is defined for a code block, it will be assigned to the + `<code>` tag as a class in the manner suggested by the [HTML5 spec][spec] + (alternate output will not be entertained) and might be used by a JavaScript + library in the browser to highlight the code block. + +[spec]: http://www.w3.org/TR/html5/text-level-semantics.html#the-code-element diff --git a/docs/release-2.6.txt b/docs/release-2.6.txt index 783837e..030d890 100644 --- a/docs/release-2.6.txt +++ b/docs/release-2.6.txt @@ -202,6 +202,18 @@ worked on PyPy for some time, it is now officially supported and tested on PyPy. [TOC]: extensions/toc.html +* The [CodeHilite][ch] Extension has gained a new config option: `use_pygments`. + The option is `True` by default, however, it allows one to turn off Pygments code + highlighting (set to `False`) while preserving the language detection features of + the extension. Note that Pygments language detection is not used as that would 'use + Pygments`. If a language is defined for a code block, it will be assigned to the + `<code>` tag as a class in the manner suggested by the [HTML5 spec][spec] + (alternate output will not be entertained) and might be used by a JavaScript + library in the browser to highlight the code block. + +[ch]: extensions/code_hilite.html +[spec]: http://www.w3.org/TR/html5/text-level-semantics.html#the-code-element + * Test coverage has been improved including running [flake8]. While those changes will not directly effect end users, the code is being better tested which will benefit everyone. |