https://github.com/euclio/aurelius

A complete solution for previewing markdown written in Rust.
https://github.com/euclio/aurelius

editor-plugin markdown rust websockets

Last synced: about 1 month ago
JSON representation

A complete solution for previewing markdown written in Rust.

• Host: GitHub
• URL: https://github.com/euclio/aurelius
• Owner: euclio
• License: apache-2.0
• Created: 2015-07-27T05:21:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T13:18:54.000Z (5 months ago)
• Last Synced: 2024-09-29T02:05:57.584Z (about 2 months ago)
• Topics: editor-plugin, markdown, rust, websockets
• Language: Rust
• Size: 3.46 MB
• Stars: 85
• Watchers: 5
• Forks: 10
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# aurelius

[aurelius](https://github.com/euclio/aurelius) is a complete solution for

live-previewing markdown as HTML.

![](https://github.com/euclio/aurelius/workflows/Continuous%20integration/badge.svg)

[![crates.io](http://meritbadge.herokuapp.com/aurelius)](https://crates.io/crates/aurelius)

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][docs].

This crate was designed to power [vim-markdown-composer], a markdown preview plugin for

[Neovim](http://neovim.io), but it may be used to implement similar plugins for any editor.

See [vim-markdown-composer] for a real-world usage example.

## Acknowledgments

This crate is inspired by suan's

[instant-markdown-d](https://github.com/suan/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](https://en.wikipedia.org/wiki/Aurelia_(gens)).

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.

[vim-markdown-composer]: https://github.com/euclio/vim-markdown-composer

[docs]: https://docs.rs/crate/aurelius