Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/varya/docpad-plugin-kramed


https://github.com/varya/docpad-plugin-kramed

Last synced: 5 days ago
JSON representation

Awesome Lists containing this project

README

        

# Marked Plugin for [DocPad](http://docpad.org)

[![Build Status](https://img.shields.io/travis/docpad/docpad-plugin-marked/master.svg)](http://travis-ci.org/docpad/docpad-plugin-marked "Check this project's build status on TravisCI")
[![NPM version](https://img.shields.io/npm/v/docpad-plugin-marked.svg)](https://npmjs.org/package/docpad-plugin-marked "View this project on NPM")
[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-marked.svg)](https://npmjs.org/package/docpad-plugin-marked "View this project on NPM")
[![Dependency Status](https://img.shields.io/david/docpad/docpad-plugin-marked.svg)](https://david-dm.org/docpad/docpad-plugin-marked)
[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-marked.svg)](https://david-dm.org/docpad/docpad-plugin-marked#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")

[Markdown](http://daringfireball.net/projects/markdown/) rendering for [DocPad](http://docpad.org), using [Marked](https://github.com/chjj/marked)

Convention: `.html.md|markdown`

## Install

``` bash
docpad install marked
```

## Configure
For information on customising your plugin configuration you can refer to the [DocPad FAQ](https://github.com/bevry/docpad/wiki/FAQ)

### Marked Options
You can customise the [Marked](https://github.com/chjj/marked) [options](https://github.com/chjj/marked#options) by using the `markedOptions` object. By default we use:

pedantic: false
gfm: true
sanitize: false
highlight: null

## History
[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/docpad/docpad-plugin-marked/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-marked/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-marked/commits?author=balupton)
- [Chase Colman](https://github.com/chase) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=chase)
- [daphne-d](https://github.com/daphne-d) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=daphne-d)
- [Delapouite](https://github.com/Delapouite) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=Delapouite)
- [kizu](https://github.com/kizu) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=kizu)
- [RobLoach](https://github.com/RobLoach) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=RobLoach)
- [varya](https://github.com/varya) — [view contributions](https://github.com/docpad/docpad-plugin-marked/commits?author=varya)

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

## License

Unless stated otherwise all works are:

- Copyright © 2012+ Bevry Pty Ltd (http://bevry.me)
- Copyright © 2011 Benjamin Lupton (http://balupton.com)

and licensed under:

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