You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
1.0 KiB

  1. # Marked Plugin for DocPad
  2. [Markdown](http://daringfireball.net/projects/markdown/) rendering for [DocPad](https://docpad.org), using [Marked](https://github.com/chjj/marked)
  3. Convention: `.html.md|markdown`
  4. ## Install
  5. ```
  6. npm install --save docpad-plugin-marked
  7. ```
  8. ## Configure
  9. For information on customising your plugin configuration you can refer to the [DocPad FAQ](https://github.com/bevry/docpad/wiki/FAQ)
  10. ### Marked Options
  11. 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:
  12. pedantic: false
  13. gfm: true
  14. sanitize: false
  15. highlight: null
  16. ## History
  17. You can discover the history inside the `History.md` file
  18. ## License
  19. Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
  20. <br/>Copyright &copy; 2012 [Bevry Pty Ltd](http://bevry.me)
  21. <br/>Copyright &copy; 2011 [Benjamin Lupton](http://balupton.com)