Crate present

present is a simple tool that lets you interpolate the standard output of arbitrary scripts that get interpreted by the shell into your markdown documents.

With present, you can create a File struct by pointing it to a path. This will parse all codeblocks with the present prefix, and add them as commands to the struct. From there, you can present the file by using the File::present function, which will modify the internal content. From there, you can use the File::print or File::save functions to print the presented document to stdout or save it back to the original file.

use std::path::PathBuf;

let mut file = present::File::new(PathBuf::from("README.md")).unwrap();
file.present().unwrap();
file.save();

Structs

Diff

Represents a diff in a File

File

Represents a parsed Markdown file that can be presented

Enums

Error

Present’s internal error type

Type Aliases

Result

Present’s internal result type