diff options
| author | Waylan Limberg <waylan.limberg@icloud.com> | 2017-09-18 10:06:24 -0400 |
|---|---|---|
| committer | Waylan Limberg <waylan.limberg@icloud.com> | 2017-09-18 10:23:36 -0400 |
| commit | e839a487edd1f6ceeb07577c015b5979b7a3ebd1 (patch) | |
| tree | 193cd3844134beb68588169bf2bdd1d693f26a81 | |
| parent | 2c7ec0c21b412f5242951a3ced9628cf6d3fc0a7 (diff) | |
| download | markdown-e839a487edd1f6ceeb07577c015b5979b7a3ebd1.tar.gz markdown-e839a487edd1f6ceeb07577c015b5979b7a3ebd1.tar.bz2 markdown-e839a487edd1f6ceeb07577c015b5979b7a3ebd1.zip | |
Clean up some docs formatting.
| -rw-r--r-- | .spell-dict | 1 | ||||
| -rw-r--r-- | docs/extensions/code_hilite.txt | 16 |
2 files changed, 9 insertions, 8 deletions
diff --git a/.spell-dict b/.spell-dict index 677e2a3..44d0a16 100644 --- a/.spell-dict +++ b/.spell-dict @@ -70,6 +70,7 @@ refactor refactored refactors registerExtension +richeland RSS rST ryneeverett diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt index 52c101e..c2980f2 100644 --- a/docs/extensions/code_hilite.txt +++ b/docs/extensions/code_hilite.txt @@ -38,7 +38,7 @@ command from the command line: pygmentize -S default -f html -a .codehilite > styles.css -If you are using a different `css_class` (default: `codehilite`), then +If you are using a different `css_class` (default: `.codehilite`), then set the value of the `-a` option to that class name. The CSS rules will be written to the `styles.css` file which you can copy to your site and link from your HTML templates. @@ -49,23 +49,23 @@ installed via Pygments plugins), run the following command: pygmentize -L style -!!! see also +See Pygments' excellent [documentation] for more details. If no language is +defined, Pygments will attempt to guess the language. When that fails, the code +block will not be highlighted. + +!!! note "See Also" GitHub user [richeland] has provided a number of different [CSS style sheets][rich] which work with Pygments along with a [preview] of each theme. The `css_class` used is the same as the default value for that option - (`codehilite`). However, the Python-Markdown project makes no guarantee that + (`.codehilite`). However, the Python-Markdown project makes no guarantee that richeland's CSS styles will work with the version of Pygments you are using. To ensure complete compatibility, you should generate the CSS rules from your own installation of Pygments. -See Pygments' excellent [documentation] for more details. If no language is -defined, Pygments will attempt to guess the language. When that fails, the code -block will not be highlighted. - [richeland]: https://github.com/richleland [rich]: https://github.com/richleland/pygments-css -[previews]: http://richleland.github.io/pygments-css/ +[preview]: http://richleland.github.io/pygments-css/ [documentation]: http://pygments.org/docs/ |