lib/markdown/README.md

   1 A markdown parser for Nit.
   2
   3 Markdown documentation can be found in http://daringfireball.net/projects/markdown/.
   4 This parser is inspired by the famous TxtMark for Java (https://github.com/rjeschke/txtmark).
   5
   6 ## Usage
   7
   8 `nitmd` can be used as a standalone tool:
   9
  10 ~~~bash
  11 $ nitmd file.md
  12 ~~~
  13
  14 Or you can use it programmatically by importing the `markdown` module.
  15
  16 ## Differences with Markdown specification
  17
  18 This parser passes all tests inside http://daringfireball.net/projects/downloads/MarkdownTest_1.0_2007-05-09.tgz execpt of two:
  19
  20 1. Images.text: fails because this parser doesn't produce empty 'title' image attributes.
  21 2. Literal quotes in titles.text: because markdown accepts unescaped quotes in titles and this is wrong.
  22
  23 ## Testing
  24
  25 The NitUnit test suite can be found in `test_markdown.nit`.
  26
  27 Minimalists tests are prefixed with `process_*`. All tests from daringfireball are prefixed with `process_daring*`.
  28
  29 Run the test suite:
  30
  31 ~~~bash
  32 $ nitunit lib/markdown/markdown.nit -t lib/markdown/test_markdown.nit
  33 ~~~