Skip to content
A complete solution for previewing markdown written in Rust.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples allow multiple custom CSS files Jan 28, 2018
src Updates (#18) Apr 26, 2019
static update dependencies Jan 28, 2018
templates
tests
.gitignore ignore Cargo.lock Jul 27, 2015
.gitmodules add method to change syntax highlighting theme Jul 28, 2015
.travis.yml use `docs.rs` for hosting documentation Apr 10, 2017
Cargo.toml Updates (#18) Apr 26, 2019
LICENSE-APACHE relicense as MIT/Apache-2.0 Jan 24, 2016
LICENSE-MIT relicense as MIT/Apache-2.0 Jan 24, 2016
README.md readme: Minor touch up Nov 22, 2017

README.md

aurelius

aurelius is a complete solution for rendering and previewing markdown.

Build Status crates.io

This crate provides a server that can render and update an HTML preview of Markdown without a client-side refresh. The server listens for both WebSocket and HTTP connections on arbitrary ports. Upon receiving an HTTP request, the server renders a page containing a Markdown preview. Client-side JavaScript then initiates a WebSocket connection which allows the server to push changes to the client.

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.

Acknowledgments

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.

Aurelia (gens) on Wikipedia.

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.

You can’t perform that action at this time.