Struct Markdown 

pub struct Markdown { /* private fields */ }

A parsed Markdown document with support for live in-place terminal rendering.

Markdown parses markdown text into an internal element tree, then renders it with ANSI escape codes. It tracks line counts between renders so subsequent calls to render overwrite the previous output in-place using terminal cursor control sequences.

Examples

use smart_markdown::{Markdown, ThemeMode};

let mut md = Markdown::parse("## Status\n\n**Running...**")
    .theme_mode(ThemeMode::Dark)
    .code_theme("base16-ocean.dark");

md.render(); // outputs to stdout

// Update a table cell and re-render
md.set_cell_content(0, 1, "new data");
md.render(); // overwrites previous output in-place

Implementations

impl Markdown

pub fn parse(text: &str) -> Self

Parse a markdown string into a Markdown document.

Supports: headings (ATX and setext), paragraphs, fenced/indented code blocks, blockquotes, ordered/unordered/task lists, tables, definition lists, horizontal rules, HTML blocks, footnotes, and reference links.

Examples found in repository

examples/simple.rs (line 4)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(MARKDOWN);
    md.render();

    Ok(())
}

examples/streaming.rs (lines 7-25)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(
        "## Build Pipeline\n\n\
         | Task    | Status  | Details                         |\n\
         |---------|---------|---------------------------------|\n\
         | build   | pending |                                 |\n\
         | test    | pending |                                 |\n\
         | deploy  | pending |                                 |\n\
         \n\
         _Live streaming table update demo_\n\n\
         \n\
         ### Task Status\n\n\
         - [x] Compile source\n\
         - [x] Run unit tests\n\
         - [ ] Integration tests\n\
         - [ ] Deploy to staging\n\
         \n\
         See the pipeline logs or visit <https://ci.example.com>\n\
         for detailed build output.\n",
    );

    println!("\nStreaming Markdown Demo\n-----------------------\n");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, "compiling source");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, " files...");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(1, 2, "running unit tests across all crates");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(0, 1, "done");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(1, 1, "running");
    md.append_to_cell(1, 2, " with coverage instrumentation enabled for llvm-cov");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(1200));

    md.set_cell_content(2, 1, "queued");
    md.append_to_cell(0, 2, " and linking final binary artifact");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(2, 1, "done");
    md.set_cell_content(2, 2, "release published to registry");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    println!();

    Ok(())
}

pub fn theme_mode(self, mode: ThemeMode) -> Self

Set the syntax highlighting theme mode.

When the syntax-highlight feature is enabled (on by default), this controls which syntect color theme is used for fenced code blocks.

• ThemeMode::Dark — “Base16 Eighties Dark”
• ThemeMode::Light — “Solarized (light)”
• ThemeMode::Auto — detects terminal background color at render time

pub fn code_theme(self, theme: &str) -> Self

Override the syntax highlighting theme by name.

See highlight::list_themes for available theme names. When the syntax-highlight feature is disabled, this has no effect.

pub fn has_terminal_resized(&self) -> bool

Returns true if the terminal width has changed since the last render.

Useful for deciding whether to re-render on SIGWINCH.

pub fn append_to_cell(&mut self, row: usize, col: usize, text: &str)

Append text to a table cell identified by row and column index.

Panics if the document doesn’t contain a table or the indices are out of bounds.

Examples found in repository

examples/streaming.rs (line 32)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(
        "## Build Pipeline\n\n\
         | Task    | Status  | Details                         |\n\
         |---------|---------|---------------------------------|\n\
         | build   | pending |                                 |\n\
         | test    | pending |                                 |\n\
         | deploy  | pending |                                 |\n\
         \n\
         _Live streaming table update demo_\n\n\
         \n\
         ### Task Status\n\n\
         - [x] Compile source\n\
         - [x] Run unit tests\n\
         - [ ] Integration tests\n\
         - [ ] Deploy to staging\n\
         \n\
         See the pipeline logs or visit <https://ci.example.com>\n\
         for detailed build output.\n",
    );

    println!("\nStreaming Markdown Demo\n-----------------------\n");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, "compiling source");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, " files...");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(1, 2, "running unit tests across all crates");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(0, 1, "done");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(1, 1, "running");
    md.append_to_cell(1, 2, " with coverage instrumentation enabled for llvm-cov");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(1200));

    md.set_cell_content(2, 1, "queued");
    md.append_to_cell(0, 2, " and linking final binary artifact");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(2, 1, "done");
    md.set_cell_content(2, 2, "release published to registry");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    println!();

    Ok(())
}

pub fn set_cell_content(&mut self, row: usize, col: usize, text: &str)

Replace the content of a table cell identified by row and column index.

Panics if the document doesn’t contain a table or the indices are out of bounds.

Examples found in repository

examples/streaming.rs (line 47)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(
        "## Build Pipeline\n\n\
         | Task    | Status  | Details                         |\n\
         |---------|---------|---------------------------------|\n\
         | build   | pending |                                 |\n\
         | test    | pending |                                 |\n\
         | deploy  | pending |                                 |\n\
         \n\
         _Live streaming table update demo_\n\n\
         \n\
         ### Task Status\n\n\
         - [x] Compile source\n\
         - [x] Run unit tests\n\
         - [ ] Integration tests\n\
         - [ ] Deploy to staging\n\
         \n\
         See the pipeline logs or visit <https://ci.example.com>\n\
         for detailed build output.\n",
    );

    println!("\nStreaming Markdown Demo\n-----------------------\n");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, "compiling source");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, " files...");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(1, 2, "running unit tests across all crates");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(0, 1, "done");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(1, 1, "running");
    md.append_to_cell(1, 2, " with coverage instrumentation enabled for llvm-cov");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(1200));

    md.set_cell_content(2, 1, "queued");
    md.append_to_cell(0, 2, " and linking final binary artifact");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(2, 1, "done");
    md.set_cell_content(2, 2, "release published to registry");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    println!();

    Ok(())
}

pub fn render(&mut self)

Render the document to stdout with ANSI escape codes.

On first call, output is simply printed. On subsequent calls, the previous output is overwritten in-place using cursor-up and line-clear sequences. Lines that shrink between renders are properly cleared.

Examples found in repository

examples/simple.rs (line 5)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(MARKDOWN);
    md.render();

    Ok(())
}

examples/streaming.rs (line 28)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut md = Markdown::parse(
        "## Build Pipeline\n\n\
         | Task    | Status  | Details                         |\n\
         |---------|---------|---------------------------------|\n\
         | build   | pending |                                 |\n\
         | test    | pending |                                 |\n\
         | deploy  | pending |                                 |\n\
         \n\
         _Live streaming table update demo_\n\n\
         \n\
         ### Task Status\n\n\
         - [x] Compile source\n\
         - [x] Run unit tests\n\
         - [ ] Integration tests\n\
         - [ ] Deploy to staging\n\
         \n\
         See the pipeline logs or visit <https://ci.example.com>\n\
         for detailed build output.\n",
    );

    println!("\nStreaming Markdown Demo\n-----------------------\n");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, "compiling source");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(0, 2, " files...");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.append_to_cell(1, 2, "running unit tests across all crates");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(0, 1, "done");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(1, 1, "running");
    md.append_to_cell(1, 2, " with coverage instrumentation enabled for llvm-cov");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(1200));

    md.set_cell_content(2, 1, "queued");
    md.append_to_cell(0, 2, " and linking final binary artifact");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    md.set_cell_content(2, 1, "done");
    md.set_cell_content(2, 2, "release published to registry");
    md.render();
    io::stdout().flush()?;
    thread::sleep(Duration::from_millis(800));

    println!();

    Ok(())
}