Struct Doc 

pub struct Doc(Vec<Box<str>>);

Builder for multi-line markdown documents.

Tuple Fields

0: Vec<Box<str>>

Implementations

impl Doc

pub fn new() -> Self

pub fn line(self, text: &str) -> Self

pub fn blank(self) -> Self

pub fn heading(self, level: u8, text: &str) -> Self

pub fn h1(self, text: &str) -> Self

pub fn h2(self, text: &str) -> Self

pub fn h3(self, text: &str) -> Self

pub fn numbered(self, n: usize, text: &str) -> Self

pub fn bullet(self, text: &str) -> Self

pub fn kv_bullet(self, key: &str, value: &str) -> Self

Render a bullet with a bold key and plain value: - **key:** value.

pub fn def(self, term: &str, desc: &str) -> Self

Render a bullet with an inline-code term and description: - `term` — desc.

pub fn def_detail(self, term: &str, detail: &str, desc: &str) -> Self

Render - `term` (detail) — desc.

pub fn quote(self, text: &str) -> Self

Render a blockquote (each line prefixed with >).

pub fn code_block(self, language: &str, content: &str) -> Self

pub fn raw(self, text: String) -> Self

pub fn build(self) -> String

Trait Implementations

impl Debug for Doc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Doc

fn default() -> Self

Returns the “default value” for a type.