r/o

README.md

koino

Build status Spec Status: 671/671

Zig port of Comrak. Maintains 100% spec-compatibility with GitHub Flavored Markdown.

Getting started

  • Clone the repository with submodules, as we have quite a few dependencies.

    $ git clone --recurse-submodules https://github.com/kivikakk/koino
  • Follow the libpcre.zig dependency install instructions for your operating system.

  • Build and run the spec suite.

    $ zig build test
    $ make spec
  • Have a look at the bottom of parser.zig to see some test usage.

Usage

Command line:

$ koino --help
Usage: koino [-hu] [-e <EXTENSION>...] [--smart]
Options:
-h, --help Display this help and exit
-u, --unsafe Render raw HTML and dangerous URLs
-e, --extension <EXTENSION>... Enable an extension. (table,strikethrough,autolink,tagfilter)
--smart Use smart punctuation.

Library:

Documentation is TODO โ€” see LoLa for an example of use. Note also the build.zig declaration.