markdown.hpp File Reference

Markdown document-writing helpers. More...

#include "formatters/hexdump.hpp"
#include "microfmt.hpp"
#include <algorithm>
#include <cstddef>
#include <cstdint>
#include <reloco/type_id.hpp>
#include <string_view>
#include <utility>

Include dependency graph for markdown.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	microfmt::md::column
class	microfmt::md::writer
struct	microfmt::md::bold_view
struct	microfmt::md::italic_view
struct	microfmt::md::strike_view
struct	microfmt::md::code_view
struct	microfmt::md::link_view
struct	microfmt::md::image_view
struct	microfmt::formatter< microfmt::md::bold_view >
struct	microfmt::formatter< microfmt::md::code_view >
struct	microfmt::formatter< microfmt::md::italic_view >
struct	microfmt::formatter< microfmt::md::strike_view >
struct	microfmt::formatter< microfmt::md::link_view >
struct	microfmt::formatter< microfmt::md::image_view >
class	microfmt::md::details_guard
class	microfmt::md::table_writer< NumCols >

Namespaces
namespace	microfmt
namespace	microfmt::md

Enumerations
enum class	microfmt::md::align : uint8_t { microfmt::md::left , microfmt::md::center , microfmt::md::right }
enum class	microfmt::md::admonition : uint8_t {   microfmt::md::note , microfmt::md::tip , microfmt::md::important , microfmt::md::warning ,   microfmt::md::caution }

Functions
template<typename Callable >
writer &	microfmt::md::details (writer &w, microfmt::string_view summary, Callable &&body, bool open=false) noexcept
constexpr bold_view	microfmt::md::bold (microfmt::string_view s) noexcept
constexpr italic_view	microfmt::md::italic (microfmt::string_view s) noexcept
constexpr strike_view	microfmt::md::strike (microfmt::string_view s) noexcept
constexpr code_view	microfmt::md::code (microfmt::string_view s) noexcept
constexpr link_view	microfmt::md::link (microfmt::string_view label, microfmt::string_view url) noexcept
constexpr image_view	microfmt::md::image (microfmt::string_view alt, microfmt::string_view url) noexcept
	RELOCO_TYPE_ID_NAME (microfmt::md::column, "microfmt::md::column")
	RELOCO_TYPE_ID_NAME (microfmt::md::align, "microfmt::md::align")
	RELOCO_TYPE_ID_NAME (microfmt::md::admonition, "microfmt::md::admonition")

Detailed Description

Markdown document-writing helpers.

Function Documentation

RELOCO_TYPE_ID_NAME() [1/3]

RELOCO_TYPE_ID_NAME	(	microfmt::md::admonition	,
		"microfmt::md::admonition"
	)

RELOCO_TYPE_ID_NAME() [2/3]

RELOCO_TYPE_ID_NAME	(	microfmt::md::align	,
		"microfmt::md::align"
	)

RELOCO_TYPE_ID_NAME() [3/3]

RELOCO_TYPE_ID_NAME	(	microfmt::md::column	,
		"microfmt::md::column"
	)