https://github.com/podsvirov/mdbook-pikchr
mdBook Pikchr
https://github.com/podsvirov/mdbook-pikchr
hacktoberfest mdbook pic pikchr svg
Last synced: 6 months ago
JSON representation
mdBook Pikchr
- Host: GitHub
- URL: https://github.com/podsvirov/mdbook-pikchr
- Owner: podsvirov
- License: mit
- Created: 2022-10-12T22:47:23.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-11T15:25:15.000Z (6 months ago)
- Last Synced: 2025-04-11T16:43:35.088Z (6 months ago)
- Topics: hacktoberfest, mdbook, pic, pikchr, svg
- Language: C
- Homepage: https://podsvirov.github.io/mdbook-pikchr
- Size: 1.46 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdBook Pikchr
A [mdBook][1] preprocessor to render [Pikchr][2] code blocks as images in your book.
Taken from the [Pikchr][2] homepage:
> Pikchr (pronounced like "picture") is a [PIC][3]-like markup
> language for diagrams in technical documentation. Pikchr is
> designed to be embedded in [fenced code blocks][4] of
> Markdown (or in similar mechanisms in other markup languages)
> to provide a convenient means of showing diagrams.
This [crate][5] use builtin copy of the [pikchr.c][6] file downloaded from that website.
## How it's work
## Installation
Install it via `cargo`:
```shell
$ cargo install mdbook-pikchr
```
## Configuration
Just type next line in your `book.toml` file:
```toml
[preprocessor.pikchr]
```
## Source code
Source code available on [GitHub][7].
[1]: https://rust-lang.github.io/mdBook
[2]: https://pikchr.org
[3]: https://en.wikipedia.org/wiki/Pic_language
[4]: https://spec.commonmark.org/0.29/#fenced-code-blocks
[5]: https://crates.io/crates/mdbook-pikchr
[6]: https://pikchr.org/home/file?name=pikchr.c&ci=1e14a4118c79991c
[7]: https://github.com/podsvirov/mdbook-pikchr