4 releases
0.1.3 | Jul 22, 2022 |
---|---|
0.1.2 | Oct 7, 2021 |
0.1.1 | Oct 2, 2021 |
0.1.0 | Oct 2, 2021 |
#1084 in Web programming
44KB
1K
SLoC
🎭 Prose
Turning your markdown into lovely HTML!
Prose is here to let you draft up a document and watch it render in real time.
Prose is here to let you draft up a document and watch it render in real time.
If you want to use this HTML elsewhere, just click the button above to switch the view to raw, unrendered HTML. This way you can copy&paste is anywhere you'd like.
When it is time to save your work, Prose gives you the ability download your document as an .md
file.
Built on the following tech:
- 🦀Rust as your typical programming language
- 🕸WASM to run compiled Rust code in the browser
- 🍟Nom to parse the markdown into a Syntax Tree
- 🌳Yew as the web framework
How Do I Run This?
Easy! You will need a few things.
- Install
rust
from the rust-lang site. - Install
wasm-pack
which is a crate from cargo. Just runcargo install wasm-pack
. - Run
wasm-pack build
to compile all of of the code into a wasm npm package. - Install
npm
from the npm site. - Run
npm run serve
in thewww
directory. - Navigate to
https://localhost:8080
in your browser!
Support
Prose supports the following markdown structures:
- Headers 1-6
- Ordered Lists
- Unordered Lists
- Codeblocks (no specified language support)
- boldtext
- italic text
inline_code
- Links
- Images
You may be asking: What makes this better than any other markdown parser? Well, this is implemented in a very performant systems programming language and is much much faster. Using WebAssembly, we have been able to compile this code into a format that runs super fast in the browser's JavaScript engine. You probably will see above a benchmark on how long it took to parse this. I have done my own measurements and found most tools are 30-50 times slower. Not a good look :(
Coming Soon!
- Bugfixes
- Download Feature
- New Markdown Flavors
- In-Page Timer
Dependencies
~1MB
~19K SLoC