aurelius is a complete solution for rendering and previewing markdown.
Full documentation may be found here.
This crate was designed to power vim-markdown-composer, a Markdown preview plugin for Neovim and Vim 8, but it may be used to implement similar plugins for any editor. See vim-markdown-composer for a usage example.
aurelius follows stable Rust. However, the API currently unstable and may change without warning.
This crate is inspired by suan's instant-markdown-d.
Why the name?
"Aurelius" is a Roman gens (family name) shared by many famous Romans, including emperor Marcus Aurelius, one of the "Five Good Emperors." The gens itself originates from the Latin aureus meaning "golden." Also, tell me that "Markdown Aurelius" isn't a great pun.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
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.