present 0.1.0

present

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

Demo

Below is a short demo showcasing the main functionality of the program.

Installation

You can install present with the rust package manager Cargo:

$ cargo install present

Usage

Below is the standard output of present --help, interpolated by the present binary itself!

present 0.1.0
Interpolate the standard output of arbitrary shell scripts into your markdown files

USAGE:
    present [OPTIONS]

OPTIONS:
    -h, --help           Print help information
        --in-place       Modify documents in place.
        --interactive    Interactively present markdown documents.
        --path <PATH>    A file or directory path to present.
        --pretty         Pretty print documents to the terminal.
        --recursive      Recursively present markdown documents.
        --remove         Remove commands within markdown documents.
    -V, --version        Print version information

Example

Below is the contents of a file called foo.md. You can place commands at the start of a fenced code block:

foo

```present echo bar
```

These commands can then get interpreted by the shell by invoking the present binary on foo.md:

$ present --in-place --path foo.md

The document gets modified in-place, with the commands stdout interpolated in-between the fenced code block:

foo

```present echo bar
bar
```