[mirror] CommonMark + GFM compatible Markdown parser and renderer
Go to file
Amelia Cuss 01c7680880 gitattributes: remove. 2024-04-28 12:47:13 +03:00
.github drop Windows support; rename vendored to match repo names. 2024-04-28 12:45:52 +03:00
src strings: fix update @memcpy breakages. 2024-04-28 12:04:29 +03:00
vendor drop Windows support; rename vendored to match repo names. 2024-04-28 12:45:52 +03:00
.gitignore Revert "workflows: use Nix in CI." 2024-04-28 11:13:15 +03:00
.gitmodules drop Windows support; rename vendored to match repo names. 2024-04-28 12:45:52 +03:00
LICENSE add MIT license 2020-08-27 09:36:46 +10:00
Makefile workflows: just run specs 2023-08-29 02:27:48 +10:00
README.md README: update home. 2024-04-27 17:05:32 +03:00
TODO some &[_]u8{}s 2020-10-07 12:10:24 +11:00
build.zig drop Windows support; rename vendored to match repo names. 2024-04-28 12:45:52 +03:00

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.