Package Exports

docpad-plugin-pygments

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docpad-plugin-pygments) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Pygments Plugin for DocPad

This plugin enables Pygments syntax highlighting for DocPad

NOTE: Please try the HighlightJS plugin instead, it is faster and more reliable as it is coded in JavaScript, whereas for Pygments we have to start up a new process for each code block which is incredibly slow and sometimes unreliable.

Install

Install Python

If you are on Linux or OSX, generally Python is already installed for you.
1. Installing Python via Homebrew
  1. Install Homebrew
  2. Install Python
```
brew install python
```
  3. Add the Python share directory to your path: /usr/local/share/python
  4. Now follow the generic installation instructions
Install Pip
```
easy_install pip
```
Install Pygments
```
pip install pygments
```
Include your favourite Pygments Stylesheet into your website

Usage

With Github Flavored Markdown

  ## Coffeescript with markdown backticks:

  ``` coffeescript
  alert 'hello'
  ```

  ## Guessing with markdown backticks:

  ```
  alert 'hello'
  ```

  ## Guessing with markdown standard:

      alert 'hello'

With HTML

<h2>Coffeescript with html:</h2>

<code class="highlight" lang="coffeescript">
    alert 'hello'
</code>


<h2>Guessing with html:</h2>

<code class="highlight">
    alert 'hello'
</code>

Deployment

If you are wanting to generate your DocPad website on your hosting provider, rather than deploying a static site. You will have to install pygments on the host as well. You're probably better off using the HighlightJS plugin instead.

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

docpad-plugin-pygments