chickadee » cmark

Outdated egg!

This is an egg for CHICKEN 4, the unsupported old release. You're almost certainly looking for the CHICKEN 5 version of this egg, if it exists.

If it does not exist, there may be equivalent functionality provided by another egg; have a look at the egg index. Otherwise, please consider porting this egg to the current version of CHICKEN.

cmark

Description

CHICKEN Scheme bindings to the cmark C library. CommonMark is a more highly specified version of Markdown, including most the niceties found in modern Markdown parsers.

Installation

You must also install https://github.com/jgm/cmark, since the egg uses the libcmark.so shared library - If your package manager doesn't provide a cmark package, you can install from source using the usual "make && make install" dance.

API

commonmark->html str #!key (safe #t)procedure

Converts a CommonMark string to a HTML string. By default, any raw HTML code blocks or unsafe links (eg, "javascript:...") will be removed. If you'd like to use inline HTML, set the keyword parameter 'safe' to #f.

Example

(use cmark)

(commonmark->html "# Hello world!")

;; for embedded HTML support, turn off safe mode:
(commonmark->html "<script>alert('hello');</script>" safe: #f)

Source code / Issues

https://github.com/caolan/chicken-cmark

Contents »