6 releases (breaking)
0.20.0 | Feb 4, 2025 |
---|---|
0.19.0 | Dec 17, 2024 |
0.18.0 | Sep 26, 2024 |
0.17.0 | Jul 3, 2024 |
0.16.0 | May 12, 2024 |
#1007 in GUI
634 downloads per month
Used in 3 crates
(via egui_commonmark)
87KB
2K
SLoC
A commonmark viewer for egui

This crate is egui_commonmark
's compile time variant. It is recommended to use
this crate through egui_commonmark
by enabling the macros
feature.
Usage
In Cargo.toml:
egui_commonmark = "0.20"
# Specify what image formats you want to use
image = { version = "0.25", default-features = false, features = ["png"] }
Example
use egui_commonmark::{CommonMarkCache, commonmark};
let mut cache = CommonMarkCache::default();
let _response = commonmark!(ui, &mut cache, "# ATX Heading Level 1");
Alternatively you can embed a file
Example
use egui_commonmark::{CommonMarkCache, commonmark_str};
let mut cache = CommonMarkCache::default();
commonmark_str!(ui, &mut cache, "content.md");
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Dependencies
~8–13MB
~180K SLoC