Skip to content

edited setup docs for CodeHilite with Pygments #480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2016
Merged

edited setup docs for CodeHilite with Pygments #480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/extensions/code_hilite.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,27 @@ This extension is included in the standard Markdown library.
Setup
-----

### Step 1: download and install Pygments ###

You will also need to [download][dl] and install the Pygments package on your
`PYTHONPATH`. You will need to determine the appropriate CSS classes and create
appropriate rules for them, which are either defined in or linked from the
header of your HTML templates. See the excellent [documentation][] for more
`PYTHONPATH`. The CodeHilite extension will produce HTML output without Pygments,
but it won't highlight anything.

[dl]: http://pygments.org/download/

### Step 2: add CSS classes ###

You will need to determine the appropriate CSS classes and/or JavaScript with
appropriate rules. The CSS classes either need to be defined in or linked from
the header of your HTML templates. Ready-made [CSS files for Python][rich] are available.

See the 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.

[dl]: http://pygments.org/download/
[rich]: https://github.com/richleland/pygments-css
[documentation]: http://pygments.org/docs

!!! Note
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.

Syntax
------
Expand Down