Skip to content

rambip/rust-web-markdown

Repository files navigation

web-framework-markdown

This crate is a work in progress to create libraries to render markdown for the main rust web frameworks:

Framework Package Crate Source
Dioxus dioxus-markdown https://crates.io/crates/dioxus-markdown here
Leptos leptos-markdown coming soon here
Yew yew-markdown https://crates.io/crates/yew-markdown here

Examples

Take a look at the different examples !

The following examples are build using Yew, but they are implemented for all frameworks.

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

Contribute

PRs are very much appreciated.

Changelog

0.1.0

  • Mark ElementAttributes as non_exhaustive so future changes can add more attributes as a non breaking change.
  • Include crate README.
  • Require use of methods to access contents of MdComponentProps's attributes. This also removes the ability fore consumers to directly construct a MdComponentProps instance.
  • Expose the location of MdComponentProps attributes in the source as a range.
  • HtmlError has been removed from the package API.
  • Replace katexwith katex-rs for math rendering, improving performance and platform support.
  • Fix empty crash on empty codeblocks.
  • Add opt out for preserving html.
  • Documentation improvements.

About

Framework-agnostic markdown component

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published