Disclaimer

This project is now archived, it moved to https://github.com/rambip/rust-web-markdown

That was the bad news, the good news is that it is now published on crates.io !

https://crates.io/crates/yew-markdown

Goal

Creating a simple library to render markdown with yew. The best rust crates are involved !

Usage

Add yew-markdown to your project:

# Cargo.toml
yew-markdown = {git="https://github.com/rambip/yew-markdown"}

If you just need to render basic markdown, you can do

use yew_markdown::Markdown;
...
    html!{
        <Markdown src={"# Markdown power !"}/>
    }

Examples

Take a look at the different examples ! You just need trunk and a web-browser to test them.

Showcase

the example is included in ./examples/showcase

Here is an illustration:

see here

Editor

Of course, an example of a basic markdown editor is implemented to show what is currently supported

see here

Interactivity

see here

Custom Components

see here

ROADMAP

• implement note reference and image reference
• publish as a crate as soon as it is stable