((section 2 "Outdated egg!" (p "This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for " (int-link "/eggref/5/lowdown" "the CHICKEN 5 version of this egg") ", if it exists.") (p "If it does not exist, there may be equivalent functionality provided by another egg; have a look at the " (link "https://wiki.call-cc.org/chicken-projects/egg-index-5.html" "egg index") ". Otherwise, please consider porting this egg to the current version of CHICKEN.") (tags "egg")) (section 2 "lowdown" (p "Lowdown is a pure Chicken Scheme " (link "http://daringfireball.net/projects/markdown/" "Markdown") " parser library. It's mostly a port of " (link "https://github.com/jgm/peg-markdown/" "John MacFarlane's Markdown PEG") " to " (int-link "comparse") " parser combinators. Unlike the " (int-link "discount") " parser (and the original " (tt "Markdown.pl") " for that matter) it passes all 22 tests of the MarkdownTest suite (version 1.0.3) and emits " (link "http://okmij.org/ftp/Scheme/SXML.html" "SXML") " rather than a serialized HTML string. This allows for flexible post-processing of the parse result using, for example, " (int-link "sxml-transforms") ".") (toc) (section 3 "API" (def (sig (procedure "(markdown->sxml input)" (id markdown->sxml))) (p "Parses the Markdown formatted " (tt "input") " and returns an SXML representation of the resulting HTML document. " (tt "input") " may be a string, an input port or a list of characters.")) (def (sig (procedure "(markdown->sxml* input)" (id markdown->sxml*))) (p "Parses the Markdown formatted " (tt "input") " and returns an SXML representation of it. " (tt "input") " may be a string, an input port or a list of characters.")) (def (sig (procedure "(markdown-sxml->html-sxml markdown-sxml)" (id markdown-sxml->html-sxml))) (p "Turns the " (tt "markdown-sxml") " structure as returned by " (tt "markdown->sxml*") " into an SXML structure as returned by " (tt "markdown->sxml") ".")) (def (sig (procedure "(markdown->html input)" (id markdown->html))) (p "Convenience procedure which calls " (tt "markdown->sxml") " on " (tt "input") " and serializes the resulting HTML document to " (tt "(current-output-port)") "."))) (section 3 "About this egg" (section 4 "Source" (p "The " (link "https://bitbucket.org/DerGuteMoritz/lowdown" "source code is hosted at Bitbucket") ". Feel free to fork it and send pull requests there.")) (section 4 "Author" (p (int-link "/users/moritz-heidkamp" "Moritz Heidkamp"))) (section 4 "Version history" (dl (dt "2") (dd "Handle whitespace and dashes in reference labels (thanks to Vasilij Schneidermann for the patch)") (dt "1") (dd "Add support for CHICKEN 5 (thanks to Evan Hanson for the initial patch)") (dt "0.0.7") (dd "Support Setext heading at end of input (thanks ente for reporting the issue). Allow any tag names in inline HTML elements. Fix some inline corner cases (thanks to John Foerch for reporting the issue). Fix compile warning with Comparse 0.1.0. Fix inline markup in headings (thanks to Alex Charlton for reporting the issue).") (dt "0.0.6") (dd "Preserve newlines in `...` inlines (thanks to John Foerch for reporting the issue)") (dt "0.0.5") (dd "Compile with " (tt "-O3") ". Fix alphanumeric-ascii parser to also include uppercase letters (thanks Markus Klotzbuecher for reporting). Add " (int-link "smartypants") " support to " (tt "lowdown-extra") " (thanks retroj for the idea). Fix bug that inline markup would span across blocks (thanks retroj for reporting).") (dt "0.0.4") (dd "Fix bug in the newline parser (" (tt "\\r\\n") " line endings didn't work)") (dt "0.0.3") (dd "Bugfix release to make the test suite work with " (tt "chicken-install")) (dt "0.0.2") (dd "Add " (tt "markdown->html")) (dt "0.0.1") (dd "Initial release"))) (section 4 "License" (pre " Copyright (c) 2018, Moritz Heidkamp\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are\n met:\n \n Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n \n Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n \n Neither the name of the author nor the names of its contributors may\n be used to endorse or promote products derived from this software\n without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\n FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\n COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,\n INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\n STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\n ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\n OF THE POSSIBILITY OF SUCH DAMAGE.")))))