diff options
Diffstat (limited to 'docs/extensions/code_hilite.txt')
| -rw-r--r-- | docs/extensions/code_hilite.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/extensions/code_hilite.txt b/docs/extensions/code_hilite.txt index 92f8c12..5e802b8 100644 --- a/docs/extensions/code_hilite.txt +++ b/docs/extensions/code_hilite.txt @@ -25,23 +25,23 @@ You will also need to [download][dl] and install the Pygments package on your appropriate rules for them, which are either defined in or linked from the header of your HTML templates. 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 display as un-highlighted code. +language. When that fails, the code block will not be highlighted. [dl]: http://pygments.org/download/ [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. + default CSS styles which you may find to be a useful starting point. Syntax ------ The CodeHilite extension follows the same [syntax][] as regular Markdown code -blocks, with one exception. The hiliter needs to know what language to use for -the code block. There are three ways to tell the hiliter what language the code -block contains and each one has a different result. +blocks, with one exception. The highlighter needs to know what language to use for +the code block. There are three ways to tell the highlighter what language the +code block contains and each one has a different result. !!! Note The format of the language identifier only effects the display of line numbers @@ -52,9 +52,9 @@ block contains and each one has a different result. [syntax]: http://daringfireball.net/projects/markdown/syntax#precode -### SheBang (with path) ### +### Shebang (with path) ### -If the first line of the codeblock contains a shebang, the language is derived +If the first line of the code block contains a shebang, the language is derived from that and line numbers are used. #!/usr/bin/python @@ -65,7 +65,7 @@ Will result in: #!/usr/bin/python # Code goes here ... -### SheBang (no path) ### +### Shebang (no path) ### If the first line contains a shebang, but the shebang line does not contain a path (a single `/` or even a space), then that line is removed from the code @@ -92,7 +92,7 @@ Will result in: # Code goes here ... Certain lines can be selected for emphasis with the colon syntax. When -using Pygments' default css styles, emphasized lines have a yellow background. +using Pygments' default CSS styles, emphasized lines have a yellow background. This is useful to direct the reader's attention to specific lines. :::python hl_lines="1 3" @@ -143,7 +143,7 @@ The following options are provided to configure the output: Using `True` will force every code block to have line numbers, even when using colons (`:::`) for language identification. - Using `False` will turn off all line numbers, even when using SheBangs + Using `False` will turn off all line numbers, even when using shebangs (`#!`) for language identification. * **`guess_lang`**: @@ -157,7 +157,7 @@ The following options are provided to configure the output: `codehilite`. * **`pygments_style`**: - Pygments HTML Formatter Style (ColorScheme). Defaults to `default`. + Pygments HTML Formatter Style (`ColorScheme`). Defaults to `default`. !!! Note This is useful only when `noclasses` is set to `True`, otherwise the |