#markdown #vim


A complete solution for previewing markdown

28 releases

0.7.5 Jun 27, 2022
0.7.3 Aug 15, 2020
0.7.2 Feb 7, 2020
0.6.3 Apr 28, 2019
0.1.2 Jul 28, 2015

#96 in WebSocket

Download history 48/week @ 2023-11-04 37/week @ 2023-11-11 39/week @ 2023-11-18 150/week @ 2023-11-25 90/week @ 2023-12-02 40/week @ 2023-12-09 79/week @ 2023-12-16 95/week @ 2023-12-23 58/week @ 2023-12-30 45/week @ 2024-01-06 48/week @ 2024-01-13 65/week @ 2024-01-20 140/week @ 2024-01-27 24/week @ 2024-02-03 131/week @ 2024-02-10 487/week @ 2024-02-17

788 downloads per month
Used in 2 crates


34K SLoC

JavaScript 34K SLoC // 0.1% comments Rust 557 SLoC // 0.0% comments


aurelius is a complete solution for live-previewing markdown as HTML.


This crate provides a server that can render and update an HTML preview of markdown without a client-side refresh. Upon receiving an HTTP request, the server responds with an HTML page containing a rendering of supplied markdown. 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, but it may be used to implement similar plugins for any editor. See vim-markdown-composer for a real-world usage example.


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.


Licensed under either of

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.


~219K SLoC