25 releases (14 breaking)

0.15.0 Apr 2, 2024
0.14.0 Mar 26, 2024
0.13.0 Feb 20, 2024
0.10.2 Dec 13, 2023
0.1.3 Mar 24, 2022

#59 in GUI

Download history 439/week @ 2023-12-22 397/week @ 2023-12-29 1159/week @ 2024-01-05 1051/week @ 2024-01-12 1197/week @ 2024-01-19 1137/week @ 2024-01-26 1418/week @ 2024-02-02 1381/week @ 2024-02-09 1166/week @ 2024-02-16 1648/week @ 2024-02-23 1330/week @ 2024-03-01 1276/week @ 2024-03-08 2252/week @ 2024-03-15 1487/week @ 2024-03-22 1758/week @ 2024-03-29 2622/week @ 2024-04-05

8,480 downloads per month
Used in 17 crates (3 directly)

MIT/Apache

80KB
2K SLoC

A commonmark viewer for egui

Crate Documentation

showcase

While this crate's main focus is commonmark, it also supports a subset of Github's markdown syntax: tables, strikethrough, tasklists and footnotes.

Usage

In Cargo.toml:

egui_commonmark = "0.15"
# Specify what image formats you want to use
image = { version = "0.24", default-features = false, features = ["png"] }
use egui_commonmark::*;
let markdown =
r"# Hello world

* A list
* [ ] Checkbox
";

let mut cache = CommonMarkCache::default();
CommonMarkViewer::new("viewer").show(ui, &mut cache, markdown);

Features

  • better_syntax_highlighting: Syntax highlighting inside code blocks with syntect
  • svg: Support for viewing svg images
  • fetch: Images with urls will be downloaded and displayed

Examples

For an easy intro check out the hello_world example. To see all the different features egui_commonmark has to offer check out the book example.

License

Licensed under either of

at your option.

Dependencies

~5–18MB
~191K SLoC