mdsplode

A CLI tool for exploding and serialising Markdown files (metadata, AST, rendered parts, and rendered whole)

About

This tool came about as a result of a pressing need in some LFE projects that required finer-grained processing of Markdown files for publishing projects.

Dependencies

The project is written in Rust and depends upon that toolchain as well as the usual gcc toolchain. In addition, the library files for jq and oniguruma are needed. For instructions on how to install these, see Supporting jq Queries.

Shell

The primary use case for mdsplode is to be managed my another long-running process that writes to mdsplode's stdin and reads from its stdout. This is accomplished via an interactive shell.

The shell is started with that as the command on the CLI:

cargo install mdsplode
mdsplode shell

Or, from a clone of this repo:

cd mdsplode
make build
./bin/mdsplode shell