Skip to content

Commit

Permalink
Clean up some docs formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
waylan committed Sep 18, 2017
1 parent 2c7ec0c commit e839a48
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
1 change: 1 addition & 0 deletions .spell-dict
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ refactor
refactored
refactors
registerExtension
richeland
RSS
rST
ryneeverett
Expand Down
16 changes: 8 additions & 8 deletions docs/extensions/code_hilite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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/


Expand Down

0 comments on commit e839a48

Please sign in to comment.