Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad-archive/docpad-plugin-pygments

Adds support for Pygments Syntax Highlighting to DocPad
https://github.com/docpad-archive/docpad-plugin-pygments

docpad-plugin unsupported

Last synced: 2 days ago
JSON representation

Adds support for Pygments Syntax Highlighting to DocPad

Host: GitHub
URL: https://github.com/docpad-archive/docpad-plugin-pygments
Owner: docpad-archive
License: other
Created: 2012-10-17T02:03:01.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2018-06-10T09:24:47.000Z (over 6 years ago)
Last Synced: 2024-10-27T05:15:02.447Z (11 days ago)
Topics: docpad-plugin, unsupported
Language: CoffeeScript
Homepage:
Size: 55.7 KB
Stars: 3
Watchers: 18
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Pygments Plugin for [DocPad](https://docpad.org)

[![Build Status](https://img.shields.io/travis/docpad/docpad-plugin-pygments/master.svg)](http://travis-ci.org/docpad/docpad-plugin-pygments "Check this project's build status on TravisCI")

[![NPM version](https://img.shields.io/npm/v/docpad-plugin-pygments.svg)](https://npmjs.org/package/docpad-plugin-pygments "View this project on NPM")

[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-pygments.svg)](https://npmjs.org/package/docpad-plugin-pygments "View this project on NPM")

[![Dependency Status](https://img.shields.io/david/docpad/docpad-plugin-pygments.svg)](https://david-dm.org/docpad/docpad-plugin-pygments)

[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-pygments.svg)](https://david-dm.org/docpad/docpad-plugin-pygments#info=devDependencies)


[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

This plugin enables [Pygments](http://pygments.org/) syntax highlighting for [DocPad](https://docpad.org)

**NOTE: Please try the [HighlightJS](http://docpad.org/plugin/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

1. Install Python Dependency

	If you are on Linux or OSX, generally Python is already installed for you.

	1. Installing Python via Homebrew

		1. [Install Homebrew](http://mxcl.github.com/homebrew/)

		2. Install Python Dependency

			``` bash

			brew install python

			```

		3. Add the Python share directory to your path: `/usr/local/share/python`

		4. Now follow the generic installation instructions

2. Install Pip Dependency

	``` bash

	easy_install pip

	```

3. Install Pygments Dependency

	```

	pip install pygments

	```

4. Include your favourite [Pygments Stylesheet](https://github.com/richleland/pygments-css) into your website

5. Install this Plugin

	```

	docpad install pygments

	```

## 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

	``` html

	
Coffeescript with html:


	

		alert 'hello'

	

	
Guessing with html:


	

		alert 'hello'

	

	```

## 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](http://docpad.org/plugin/highlightjs) plugin instead.

## History

[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/docpad/docpad-plugin-pygments/blob/master/HISTORY.md#files)

## Contribute

[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/docpad/docpad-plugin-pygments/blob/master/CONTRIBUTING.md#files)

## Backers

### Maintainers

These amazing people are maintaining this project:

- Benjamin Lupton  (https://github.com/balupton)


### Sponsors

No sponsors yet! Will you be the first?

[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

### Contributors

These amazing people have contributed code to this project:

- [Benjamin Lupton](https://github.com/balupton)  — [view contributions](https://github.com/docpad/docpad-plugin-pygments/commits?author=balupton)


[Become a contributor!](https://github.com/docpad/docpad-plugin-pygments/blob/master/CONTRIBUTING.md#files)

## License

Unless stated otherwise all works are:

- Copyright © 2012+ Bevry Pty Ltd  (http://bevry.me)

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)