Markdown rendering for DocPad, using Marked
Switch branches/tags
Clone or download
Pull request Compare This branch is 5 commits ahead, 13 commits behind docpad:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
out
src
test
.editorconfig
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
Cakefile
HISTORY.md
LICENSE.md
README.md
coffeelint.json
package.json

README.md

Marked Plugin for DocPad

Forking Note

This fork is to support custom Renderer provided by Marked and heavily inspired from this issue.

To override a renderer define the function in the plugin's config:

docpadConfig:
  plugins:
    marked:
      markedRenderer:
        heading: (text, level) ->
          "<h#{level}>#{text}</h#{level}>"

Markdown rendering for DocPad, using Marked

Convention: .html.md|markdown

Install

docpad install marked

Configure

For information on customising your plugin configuration you can refer to the DocPad FAQ

Marked Options

You can customise the 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.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2012+ Bevry Pty Ltd us@bevry.me (http://bevry.me)
Copyright © 2011 Benjamin Lupton b@lupton.cc (http://balupton.com)