Did you know ... Search Documentation:
Packs (add-ons) for SWI-Prolog

Package "markdown"

Title:Markdown parser for SWI-Prolog
Rating:Not rated. Create the first rating!
Latest version:0.0.2
SHA1 sum:125f7aaef909d5be5301565052e8eba8b0ed66d4
Author:Raivo Laanemets http://rlaanemets.com/
Home page:https://github.com/rla/prolog-markdown

Reviews

No reviews. Create the first review!.

Details by download location

VersionSHA1#DownloadsURL
0.0.1da7960b745f4c1b94a9360ace3e02615eaa20ad36http://packs.rlaanemets.com/markdown/markdown-0.0.1.tgz
0.0.2125f7aaef909d5be5301565052e8eba8b0ed66d480http://packs.rlaanemets.com/markdown/markdown-0.0.2.tgz

Prolog-markdown

Markdown parser implemented in Prolog. Compatible with SWI-Prolog as the output tree is for direct use by html/1. The specification for the parser was taken from http://daringfireball.net/projects/markdown/syntax (Gruber's Markdown).

Example usage

Parse into a structure usable by html/1.

:- use_module(library(md/md_parse)).

?- md_parse_string("# Hello #", Blocks).
Blocks = [h1("Hello")].

Convert into an HTML string:

:- use_module(library(md/md_parse)).

?- md_html_string("# Hello #", Html).
Html = "<h1>Hello</h1>".

Deviations from the Gruber's Markdown

  • Some cases for tight markup (no separate lines between blocks).
  • No clever encoding for mail addresses.
  • Line break rule creates `<br> not <br />`.
  • No in-word emphasis with underscores.
  • Strikethrough as `~~text~~`.
  • Added escape sequences \~ and \ `.
  • Github-styled fenced code blocks (https://help.github.com/articles/github-flavored-markdown). No syntax highlighting is provided but the data-language attribute is set.
  • Plain link recognizion.

Performance

Example document (about 800 lines) is parsed in 80ms on 2.4GHz Q6600.

Installation

Requires SWI-Prolog 7.x.

pack_install('http://packs.rlaanemets.com/markdown/markdown-*.tgz')

API documentation

See http://packs.rlaanemets.com/markdown/doc/md_parse.html for the top-level module documentation.

Changelog

  • 2014-02-26 version 0.0.2. Fixed HTTPS link in angled brackets. Trimmed bottom of code block.
  • 2014-01-14 version 0.0.1

Bug reports/feature requests

Please send bug reports/feature request through the GitHub project page.

License

The MIT License. See the LICENSE file.

Contents of pack "markdown"

Pack contains 25 files holding a total of 65.9K bytes.