Markdown Builder

markdown-builder is an opinionated Rust crate for programmatically building markdown documents. This project is based of the markdown-composer crate by mainrs.

cargo add markdown-builder

Features

• Headers
• Paragraphs
  • Word wrapping
• Images
  • Footer
  • Alt text
• Links
  • Footer
• Lists
  • Ordered
  • Unordered
  • Checkboxes
• Transformations
  • Italic
  • Bold
  • Strikethrough
  • Codeblocks
  • Inline code
  • Blockquote

Usage

Note

The builders will often panic when you try to do stupid things. If you create the structs directly, it will not panic, resulting in potentially invalid markdown.

To fully get the gripe of markdown-builder, a good starting point is the documentation or unit tests. Here however, is a simple example.

let mut doc = Markdown::new();

doc.image(
  ImageBuilder::new()
    .url("https://example.com/picture.png")
    .text("A cute picture of a sandcat")
    .footer()
    .build(),
);

doc.paragraph("Hello World");

println!("output: {}", doc.render())

Why fork?

This project was forked out of markdown-composer due to a multitude of reasons:

• Fun
• Markdown-composer looked unmaintained
• Not wanting the additional settings to make it work for everyone
• Word wrapping