diff --git a/egui_commonmark/examples/README.md b/egui_commonmark/examples/README.md new file mode 100644 index 0000000..a3cd708 --- /dev/null +++ b/egui_commonmark/examples/README.md @@ -0,0 +1,39 @@ +# Overview of examples + +## hello_world.rs + +A good starting point. + +## interactive.rs + +An interactive example where you can play around with the markdown text at +runtime. + +## book.rs + +Intended to show all the different rendering features of the crate. + +## macros.rs + +Features compile time markdown parsing. + +## show_mut.rs + +How to make checkboxes interactive. + +## link_hooks.rs + +Allow hijacking links for doing operations within the application such as +changing a markdown page in a book without displaying the destination link. + +## mixing.rs + +Shows commonmark elements mixed with egui widgets. It displays the widgets with +no spaces in between as if the markdown was egui widgets. + +## scroll.rs + +Intended to allow showing a long markdown text and only process the displayed +parts. Currently it only works in very basic cases, the feature requires some +more work to be generally useful. +