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

Markdown rendering for DocPad, using Robotskirt (Sundown)
https://github.com/docpad-archive/docpad-plugin-robotskirt

docpad-plugin unsupported

Last synced: 2 days ago
JSON representation

Markdown rendering for DocPad, using Robotskirt (Sundown)

Host: GitHub
URL: https://github.com/docpad-archive/docpad-plugin-robotskirt
Owner: docpad-archive
License: other
Created: 2012-10-17T03:38:08.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2015-06-11T11:11:07.000Z (over 9 years ago)
Last Synced: 2024-09-17T01:05:10.905Z (about 2 months ago)
Topics: docpad-plugin, unsupported
Language: CoffeeScript
Homepage:
Size: 220 KB
Stars: 6
Watchers: 18
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

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

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

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

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

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

[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-robotskirt.svg)](https://david-dm.org/docpad/docpad-plugin-robotskirt#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")

[![PayPal 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")

NOTE! [Robotskirt has become deprecated](https://github.com/benmills/robotskirt/issues/32#issuecomment-74920726) and replaced by [hoedown](https://github.com/hoedown/node-hoedown). Please use one of DocPad's other markdown [renderer plugins](https://docpad.org/docs/plugins#renderers).

[Markdown](http://daringfireball.net/projects/markdown/) rendering for [DocPad](https://docpad.org), using [Robotskirt](https://github.com/benmills/robotskirt)

Convention:	`.html.md|markdown`

> [Robotskirt is no longer supported.](https://github.com/benmills/robotskirt/issues/32#issuecomment-74920726)

## Install

``` bash

docpad install robotskirt

```

## Configure

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

### Robotskirt Options

You can customise the [Robotskirt](https://github.com/benmills/robotskirt) options using the `robotskirtOptions` object. By default we use:

``` coffee

plugins:

	robotskirt:

		robotskirtOptions:

			EXT_AUTOLINK: true

			EXT_FENCED_CODE: true

			EXT_LAX_SPACING: true

			EXT_NO_INTRA_EMPHASIS: true

			EXT_SPACE_HEADERS: true

			EXT_STRIKETHROUGH: true

			EXT_SUPERSCRIPT: true

			EXT_TABLES: true

			HTML_SKIP_HTML: false

			HTML_SKIP_STYLE: false

			HTML_SKIP_IMAGES: false

			HTML_SKIP_LINKS: false

			HTML_EXPAND_TABS: false

			HTML_SAFELINK: false

			HTML_TOC: false

			HTML_HARD_WRAP: false

			HTML_USE_XHTML: true

			HTML_ESCAPE: false

```

### SmartyPants

It makes "smart" punctuation. See more on [its homepage](http://daringfireball.net/projects/smartypants). Default is true:

``` coffee

plugins:

	robotskirt:

		smartypants: true

```

### Hightlight

It supports highlighting code blocks at build time. Following is using [highlight.js](https://github.com/isagalaev/highlight.js).

``` coffee

plugins:

	robotskirt:

		highlight: (code, lang)->

			has = lang && hl.LANGUAGES.hasOwnProperty(lang.trim())

			open = if has then '
' else ''

			body = if has then hl.highlight(lang, code).value else hl.highlightAuto(code).value

			close = '
'

			return open + body + close

```

### Inline

You can add your markup in only normal text blocks. Next example is Twitter tag exmaple. `@pismute` will be rendered `@pismute`:

``` coffee

plugins:

	robotskirt:

		inline: (src, hash)->

			out = src

			#for people

			out = out.replace /(^|[ \t]+)@([a-zA-Z0-9]+)/g, (whole, m1, m2) ->

				hash m1 + '@' + m2 + ''

			#for hash tag·

			out = out.replace /(^|[ \t]+)#([ㄱ-ㅎ가-힣a-zA-Z0-9]+)/g, (whole, m1, m2) ->

				hash m1 + '#' + m2 + ''

			return out

```

## History

[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/docpad/docpad-plugin-robotskirt/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-robotskirt/blob/master/CONTRIBUTING.md#files)

## Backers

### Maintainers

These amazing people are maintaining this project:

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

- Changwoo Park  (https://github.com/pismute)


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

[![PayPal 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-robotskirt/commits?author=balupton)

- [Changwoo Park](https://github.com/pismute)  — [view contributions](https://github.com/docpad/docpad-plugin-robotskirt/commits?author=pismute)


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

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)

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