Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Rich Markdown

Rich Markdown: markdown rendered in ImGui: text styles, headings, lists, tables, images, links, code blocks, LaTeX math and diagrams.

render(markdown_string) draws a markdown text; render_unindented() accepts an indented one; render_file() renders a file. Run the app with immapp.run(..., with_markdown=True), which loads the fonts.

Its former name, imgui_bundle.imgui_md, stays as an alias.

Upstream repository · The book’s page

Modules

In imgui_bundle (from imgui_bundle import rich_md):

Demos using it

The demos of the catalog that use it (the pictures link to their code and to the playground).

A plot and markdown, in a few lines

A plot and markdown, in a few lines

A cosine wave moves in an ImPlot plot, under a text written in markdown.

More

Both are add-ons, activated in one call: immapp.run(gui, with_implot=True, with_markdown=True). A good start for a small app.

Uses: ImPlot

Python: ▶︎ Run · Code
C++: ▶︎ Run · Code

Assets and add-ons

Assets and add-ons

Load images and icons from your assets folder, and use two add-ons: markdown and ImPlot.

More

A markdown editor with a live preview, and a pie chart whose values you can drag. Tick More info under each part to see how it is done. The add-ons are activated with immapp.AddOnsParams.

Uses: ImPlot

Python: ▶︎ Run · Code
C++: ▶︎ Run · Code

Knobs, toggles, spinners and more

Knobs, toggles, spinners and more

Knobs, toggle switches, spinners, a command palette, a dock-like cool bar: widgets beyond Dear ImGui’s own.

More

They come from the libraries in the bundle: imgui-knobs, imgui_toggle, imspinner, imgui-command-palette and ImCoolBar. Also file dialogs: the native ones (portable-file-dialogs), and ImFileDialog, drawn with ImGui.

Uses: knobs, toggles, spinners, cool bar, command palette, file dialogs

Python: ▶︎ Run · Code
C++: ▶︎ Run · Code

Markdown tour

Markdown tour

Markdown rendered in an ImGui window: styled text, tables, code, images, math, admonitions and more.

More

Each section shows its source, ready to copy. rich_md draws it directly, with no browser and no HTML engine.

Python: ▶︎ Run · Code
C++: ▶︎ Run · Code