Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.
/ dioxus-markdown Public archive

A dioxus markdown component to parse and render markdown at runtime

License

Notifications You must be signed in to change notification settings

rambip/dioxus-markdown

Repository files navigation

Disclaimer

This repository is now archived. It moved to https://github.com/rambip/rust-web-markdown

That was the bad news. The good news is that in the meantime, you can use install dioxus-markdown from crates.io !

https://github.com/rambip/dioxus-markdown/edit/main/README.md

Goal

A simple library to render markdown with dioxus, at runtime. The best rust crates are involved !

Usage

Add dioxus-markdown to your project:

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

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

use dioxus_markdown::Markdown;
...
    rsx!{
        Markdown {src:"# Mardown 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, a basic markdown editor is included.

You can test for yourself here !

Interactivity

see here

Custom Components

You can define your own components in your code and call them inside markdown !

see here

About

A dioxus markdown component to parse and render markdown at runtime

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published