code.consxy.com Git - honey/blob - README.md

   1 # Honey - a simple markdown processor
   2
   3 While it aims to target everything listed in the
   4 [Github Flavored Markdown Spec](https://github.github.com/gfm/), it currently
   5 does just a little bit of markdown that is actively used for consxy projects.
   6
   7 It parser markdown into weave-html style objects which can then be turned into
   8 strings using the weave library.
   9
  10 Right now it supports a basic version of:
  11
  12 * lists of one indentation
  13 * headings of either ATX or underline style
  14 * links
  15 * codefences
  16 * emphasis and strength
  17
  18 ## Usage
  19
  20 See [the reference page](https://consxy.com/honey/reference.html) for more information,
  21 but in general there is a ```honey:parse``` method that takes a string representing
  22 the markdown.