Skip to content

Commit

Permalink
Merge pull request #11 from RubVer/master
Browse files Browse the repository at this point in the history
Updated documentation for Release 0.2.0.
  • Loading branch information
tj committed Aug 11, 2011
2 parents 39a36a3 + 3942814 commit da7114b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Markdown.js

node bindings for the C "discount" markdown implementation by David Parsons.
Currently only simply parsing is supported, flags hopefully coming soon.

## Installation

Expand All @@ -15,7 +14,15 @@ a package management tool such as [homebrew](http://github.com/mxcl/homebrew), o

var md = require('discount');
md.parse('markdown is *awesome*')
// => "<p>markdown is <em>awesome</em></p>"
// => '<p>markdown is <em>awesome</em></p>'

### Flags

md.parse('[links](http://github.com/) are *not* allowed here', md.flags.noLinks)
// => '<p>[links](http://github.com/) are <em>not</em> allowed here</p>'

All [Discount flags](http://www.pell.portland.or.us/~orc/Code/discount/#flags) are supported:
`noLinks`, `noImage`, `noPants`, `noHTML`, `strict`, `tagText`, `noExt`, `cdata`, `noSuperscript`, `noRelaxed`, `noTables`, `noStrikethrough`, `toc`, `md1Compat`, `autolink`, `safelink`, `noHeader`, `tabStop`, `noDivQuote`, `noAlphaList`, `noDlist` and `extraFootnote`.

## License

Expand Down

0 comments on commit da7114b

Please sign in to comment.