#mdbook #pikchr #markup-language #markdown #pic #md

app mdbook-pikchr

A mdbook preprocessor to render pikchr code blocks as images in your book

10 releases

0.1.9 Nov 6, 2024
0.1.8 Oct 23, 2024
0.1.7 Oct 2, 2023
0.1.6 May 29, 2023
0.1.4 Oct 22, 2022

#376 in Text processing

Download history 36/week @ 2024-07-29 23/week @ 2024-09-23 147/week @ 2024-10-21 6/week @ 2024-10-28 129/week @ 2024-11-04 8/week @ 2024-11-11

290 downloads per month

MIT license

300KB
7K SLoC

C 7K SLoC // 0.1% comments Rust 259 SLoC

mdBook Pikchr

A mdBook preprocessor to render Pikchr code blocks as images in your book.

Taken from the Pikchr homepage:

Pikchr (pronounced like "picture") is a PIC-like markup language for diagrams in technical documentation. Pikchr is designed to be embedded in fenced code blocks of Markdown (or in similar mechanisms in other markup languages) to provide a convenient means of showing diagrams.

This crate use builtin copy of the pikchr.c file downloaded from that website.

How it's work

Installation

Install it via cargo:

$ cargo install mdbook-pikchr

Configuration

Just type next line in your book.toml file:

[preprocessor.pikchr]

Source code

Source code available on GitHub.

Dependencies

~12–23MB
~339K SLoC