From c908b0463b17919c935944e49e282fec16ca5bf0 Mon Sep 17 00:00:00 2001
From: Waylan Limberg <waylan@gmail.com>
Date: Sun, 16 Jun 2013 21:11:01 -0400
Subject: Improved codehilite docs. Document `css_class` setting.

Also cleaned up poor wording on other setting for codehilite.

Thanks for the inital suggestion @davidcorne. Fixes #223.
---
 docs/extensions/code_hilite.txt | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

(limited to 'docs/extensions')

diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt
index 116ad0f..ab09742 100644
--- a/docs/extensions/code_hilite.txt
+++ b/docs/extensions/code_hilite.txt
@@ -120,23 +120,31 @@ From the Python interpreter:
 
     >>> html = markdown.markdown(text, extensions=['codehilite'])
 
-If you want to force every code block to have line numbers, even when using 
+To force every code block to have line numbers, even when using 
 colons (`:::`) for language identification, set `linenums` to `True`.
 
     >>> html = markdown.markdown(text,
     ...     extensions=['codehilite(linenums=True)']
     ... )
 
-If you do **not** want any code block to have line numbers, even when using 
-SheBangs (`#!`) for language identification, set `linenums` to `False`.
+To turn off all line numbers, even when using SheBangs (`#!`) for 
+language identification, set `linenums` to `False`.
 
     >>> html = markdown.markdown(text,
     ...     extensions=['codehilite(linenums=False)']
     ... )
 
-If you want to prevent Pygments from guessing the language, only highlighting
-blocks when you explicitly request it, set the `guess_lang` setting to `False`.
+To prevent Pygments from guessing the language (only highlighting
+blocks when you explicitly request it) set the `guess_lang` setting to `False`.
 
     >>> html = markdown.markdown(text,
     ...     extensions=['codehilite(guess_lang=False)']
     ... )
+
+To assign a CSS class differant than the default ('codehilite') on the
+code's wrapping div, define a custom class with the `css_class` setting.
+
+    >>> html = markdown.markdown(text,
+    ...    extensions=['codehilite(css_class=myclass)']
+    ... )
+
-- 
cgit v1.2.3