X-Git-Url: https://code.consxy.com/gitweb/gitweb.cgi?p=honey;a=blobdiff_plain;f=docs%2FReference.md;fp=docs%2FReference.md;h=9781067f08b5439eb0987b7d930f86c68d704e92;hp=0000000000000000000000000000000000000000;hb=8cc10854903eef97a9c82a0e48c3ea791fb787e6;hpb=65394a399d32af71f028dc680df1b48af87c0215 diff --git a/docs/Reference.md b/docs/Reference.md new file mode 100644 index 0000000..9781067 --- /dev/null +++ b/docs/Reference.md @@ -0,0 +1,24 @@ +# Package HONEY + +Main honey package. + +Honey is a simple markdown parse that translates to weave style html, which can then be inserted into pages. + +## Contents + +* **function [parse](#function-parse)** - Parses the actual markdown, returing the html. This is the main function for the honey package. + +## Function **PARSE** + +#### Syntax: + +**parse** _str_ => _html_ + +#### Arguments and Values: + +_str_---a string, representing the markdown +_html_---a weave style html form + +#### Description: + +Parses the actual markdown, returing the html. This is the main function for the honey package.