2 unstable releases

0.2.0 Jul 5, 2021
0.1.0 May 17, 2021

#1315 in Text processing

Apache-2.0 OR MIT

485KB
11K SLoC

Logo  Unidok

Crates.io Npm Test License: Apache-2/MIT

A powerful, readable, easy-to-learn markup language

Unidok is a new Markup language, inspired by AsciiDoctor and Markdown. It is very easy to read and to learn while offering powerful features such as macros.

Installation

Here you can find pre-built binaries for Linux, Windows and macOS.

If you want to build it yourself, install the Rust toolchain and run cargo install.

Principles

Unidok should look familiar if you're familiar with Markdown. It follows the CommonMark specification closely where it makes sense, but it also omits some Markdown features that I feel are unhelpful, and adds new features. Notable examples are:

  • Supports ^superscript^, #subscript#, ~line-through~ text, tables, math formulas, and macros

  • Does not support indented code blocks, only fenced code blocks

  • Sane HTML parsing

  • It does not support laziness, i.e. in a list item or blockquote, all lines must be indented or preceded with > respectively, not just the first line

Roadmap

See here.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~6–15MB
~170K SLoC