{"id":18265100,"url":"https://github.com/docpad-archive/docpad-plugin-pygments","last_synced_at":"2025-04-09T01:42:37.749Z","repository":{"id":5092288,"uuid":"6254813","full_name":"docpad-archive/docpad-plugin-pygments","owner":"docpad-archive","description":"Adds support for Pygments Syntax Highlighting to DocPad","archived":false,"fork":false,"pushed_at":"2018-06-10T09:24:47.000Z","size":57,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-30T00:31:53.575Z","etag":null,"topics":["docpad-plugin","unsupported"],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"joakime/android-apk-parser","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docpad-archive.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-10-17T02:03:01.000Z","updated_at":"2019-11-30T20:52:25.000Z","dependencies_parsed_at":"2022-07-04T17:01:50.916Z","dependency_job_id":null,"html_url":"https://github.com/docpad-archive/docpad-plugin-pygments","commit_stats":null,"previous_names":["docpad/docpad-plugin-pygments"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docpad-archive%2Fdocpad-plugin-pygments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docpad-archive%2Fdocpad-plugin-pygments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docpad-archive%2Fdocpad-plugin-pygments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docpad-archive%2Fdocpad-plugin-pygments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docpad-archive","download_url":"https://codeload.github.com/docpad-archive/docpad-plugin-pygments/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247958710,"owners_count":21024821,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docpad-plugin","unsupported"],"created_at":"2024-11-05T11:16:59.993Z","updated_at":"2025-04-09T01:42:37.728Z","avatar_url":"https://github.com/docpad-archive.png","language":"CoffeeScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=QB8GQPZAH84N6"],"categories":[],"sub_categories":[],"readme":"# Pygments Plugin for [DocPad](https://docpad.org)\n\n\u003c!-- BADGES/ --\u003e\n\n[![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\")\n[![NPM version](https://img.shields.io/npm/v/docpad-plugin-pygments.svg)](https://npmjs.org/package/docpad-plugin-pygments \"View this project on NPM\")\n[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-pygments.svg)](https://npmjs.org/package/docpad-plugin-pygments \"View this project on NPM\")\n[![Dependency Status](https://img.shields.io/david/docpad/docpad-plugin-pygments.svg)](https://david-dm.org/docpad/docpad-plugin-pygments)\n[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-pygments.svg)](https://david-dm.org/docpad/docpad-plugin-pygments#info=devDependencies)\u003cbr/\u003e\n[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ \"Donate weekly to this project using Gratipay\")\n[![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\")\n[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=QB8GQPZAH84N6 \"Donate once-off to this project using Paypal\")\n[![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\")\n[![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\")\n\n\u003c!-- /BADGES --\u003e\n\n\nThis plugin enables [Pygments](http://pygments.org/) syntax highlighting for [DocPad](https://docpad.org)\n\n**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.**\n\n\n## Install\n\n1. Install Python Dependency\n\n\tIf you are on Linux or OSX, generally Python is already installed for you.\n\n\t1. Installing Python via Homebrew\n\n\t\t1. [Install Homebrew](http://mxcl.github.com/homebrew/)\n\n\t\t2. Install Python Dependency\n\n\t\t\t``` bash\n\t\t\tbrew install python\n\t\t\t```\n\n\t\t3. Add the Python share directory to your path: `/usr/local/share/python`\n\n\t\t4. Now follow the generic installation instructions\n\n\n2. Install Pip Dependency\n\n\t``` bash\n\teasy_install pip\n\t```\n\n\n3. Install Pygments Dependency\n\n\t```\n\tpip install pygments\n\t```\n\n4. Include your favourite [Pygments Stylesheet](https://github.com/richleland/pygments-css) into your website\n\n5. Install this Plugin\n\n\t```\n\tdocpad install pygments\n\t```\n\n\n\n## Usage\n\n- With Github Flavored Markdown\n\n\t\t## Coffeescript with markdown backticks:\n\n\t\t``` coffeescript\n\t\talert 'hello'\n\t\t```\n\n\t\t## Guessing with markdown backticks:\n\n\t\t```\n\t\talert 'hello'\n\t\t```\n\n\t\t## Guessing with markdown standard:\n\n\t\t\talert 'hello'\n\n\n- With HTML\n\n\t``` html\n\t\u003ch2\u003eCoffeescript with html:\u003c/h2\u003e\n\n\t\u003ccode class=\"highlight\" lang=\"coffeescript\"\u003e\n\t\talert 'hello'\n\t\u003c/code\u003e\n\n\n\t\u003ch2\u003eGuessing with html:\u003c/h2\u003e\n\n\t\u003ccode class=\"highlight\"\u003e\n\t\talert 'hello'\n\t\u003c/code\u003e\n\t```\n\n\n## Deployment\nIf 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.\n\n\n\u003c!-- HISTORY/ --\u003e\n\n## History\n[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)\n\n\u003c!-- /HISTORY --\u003e\n\n\n\u003c!-- CONTRIBUTE/ --\u003e\n\n## Contribute\n\n[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)\n\n\u003c!-- /CONTRIBUTE --\u003e\n\n\n\u003c!-- BACKERS/ --\u003e\n\n## Backers\n\n### Maintainers\n\nThese amazing people are maintaining this project:\n\n- Benjamin Lupton \u003cb@lupton.cc\u003e (https://github.com/balupton)\n\n### Sponsors\n\nNo sponsors yet! Will you be the first?\n\n[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ \"Donate weekly to this project using Gratipay\")\n[![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\")\n[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=QB8GQPZAH84N6 \"Donate once-off to this project using Paypal\")\n[![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\")\n[![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\")\n\n### Contributors\n\nThese amazing people have contributed code to this project:\n\n- [Benjamin Lupton](https://github.com/balupton) \u003cb@lupton.cc\u003e — [view contributions](https://github.com/docpad/docpad-plugin-pygments/commits?author=balupton)\n\n[Become a contributor!](https://github.com/docpad/docpad-plugin-pygments/blob/master/CONTRIBUTING.md#files)\n\n\u003c!-- /BACKERS --\u003e\n\n\n\u003c!-- LICENSE/ --\u003e\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright \u0026copy; 2012+ Bevry Pty Ltd \u003cus@bevry.me\u003e (http://bevry.me)\n\nand licensed under:\n\n- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)\n\n\u003c!-- /LICENSE --\u003e\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocpad-archive%2Fdocpad-plugin-pygments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocpad-archive%2Fdocpad-plugin-pygments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocpad-archive%2Fdocpad-plugin-pygments/lists"}