Struct · markdown

markdown::Block

A block of a Markdown text: its kind and what it holds.

On this page
aurore/cadran/util/markdown.hpp
#include <aurore/cadran/util/markdown.hpp>

struct markdown::Block

Types 1

enum Kind
ValueDescription
Heading

level 1 to 6

Paragraph

text, its line breaks kept

Item

a list item: level its depth (0: top), number (0: a bullet), task

Code

lines, as written

Quote

text; alert: "note", "tip", "important", "warning", "caution" or ""

Rule
Table

rows, the first one the header, each cut to MAX_COLUMNS cells

markdown.hpp:36

Attributes 9

std::string text
int level = 0
int number = 0
int task = -1

Item: -1 not a task, 0 open, 1 done.

markdown.hpp:50
std::string alert
std::string icon

Heading / Item: the emoji it opens on, in hex ("1f680")

markdown.hpp:52
std::vector< std::string > lines
std::vector< std::vector< std::string > > rows

Read from Aurore's headers by Doxygen at each build · library/include