imgui_markdown

Support development of imgui_markdown through GitHub Sponsors or Patreon

Note: development happens on the dev branch and is merged to the main branch when complete. Please check this branch prior to submitting PRs and issues, and preferably base PRs on dev.

imgui_markdown

Markdown For Dear ImGui

A permissively licensed markdown single-header library for Dear ImGui.

Requires C++11 or above

imgui_markdown currently supports the following markdown functionality:

• Wrapped text
• Headers H1, H2, H3
• Emphasis
• Indented text, multi levels
• Unordered list and sub-list
• Link
• Image
• Horizontal rule

Note - the gif above is heavily compressed due to GitHub limitations

Syntax

Wrapping

Text wraps automatically. To add a new line, use 'Return'.

Headers

# H1
## H2
### H3

Emphasis

*emphasis*
_emphasis_
**strong emphasis**
__strong emphasis__

Lists

Indent

On a new line, at the start of the line, add two spaces per indent.

Normal text
··Indent level 1
····Indent level 2
······Indent level 3
Normal text

Unordered list

On a new line, at the start of the line, add two spaces, an asterisks and a space. For nested lists, add two additional spaces in front of the asterisk per list level increment.

Normal text
··*·Unordered List level 1
····*·Unordered List level 2
······*·Unordered List level 3
······*·Unordered List level 3
··*·Unordered List level 1
Normal text

Link

[link description](https://...)

Image

Horizontal Rule

***
___

Unsupported Syntax Combinations

Non exhaustive

• Header with link, image or emphasis included - header breaks link, image, emphasis
• Emphasis with link or image - link, image break emphasis
• Multiline emphasis - new line breaks emphasis

Example Use On Windows With Links Opening In Browser

…

Projects Using imgui_markdown

Avoyd

Avoyd is a voxel Editor and Renderer, as well as a voxel game.
The in-app documentation, tutorials, and about windows use imgui_markdown with Dear ImGui.
www.avoyd.com

bgfx

Cross-platform rendering library.
bkaradzic.github.io/bgfx/overview

Imogen

GPU/CPU Texture Generator

Light Tracer

Experimental GPU ray tracer for web

Lobster Programming Language

Lobster is a statically typed programming language with a Python-esque syntax that combines the advantages of an expressive type system and compile-time memory management with a very lightweight, friendly and terse syntax, by doing most of the heavy lifting for you.
Dear ImGui sample with imgui_markdown

Visual 6502 Remix

Transistor level 6502 Hardware Simulation

hfloooh.github.io/visual6502remix

Using imgui_markdown as help viewer for Visual 6502 Remix with internal and external links:

Credits

Design and implementation - Doug Binks - @dougbinks
Implementation - Juliette Foucaut - @juliettef
Image resize example code - Soufiane Khiat
Emphasis and horizontal rule initial implementation - Dmitry Mekhontsev
Thanks to Omar Cornut for Dear ImGui

License (zlib)

Copyright (c) 2019 Juliette Foucaut and Doug Binks

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.