https://github.com/foliant-docs/foliantcontrib.blockdiag
Blockdiag preprocessor for Foliant
https://github.com/foliant-docs/foliantcontrib.blockdiag
Last synced: 5 months ago
JSON representation
Blockdiag preprocessor for Foliant
- Host: GitHub
- URL: https://github.com/foliant-docs/foliantcontrib.blockdiag
- Owner: foliant-docs
- License: mit
- Created: 2017-12-14T04:41:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T14:51:18.000Z (about 1 year ago)
- Last Synced: 2025-09-28T00:22:52.002Z (9 months ago)
- Language: Python
- Size: 26.4 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/foliantcontrib.blockdiag/) [](https://github.com/foliant-docs/foliantcontrib.blockdiag)
# Blockdiag Preprocessor for Foliant
[Blockdiag](http://blockdiag.com/) is a tool to generate diagrams from plain text. This preprocessor finds diagram definitions in the source and converts them into images on the fly during project build. It supports all Blockdiag flavors: blockdiag, seqdiag, actdiag, and nwdiag.
## Installation
```shell
$ pip install foliantcontrib.blockdiag
```
## Config
To enable the preprocessor, add `blockdiag` to `preprocessors` section in the project config:
```yaml
preprocessors:
- blockdiag
```
The preprocessor has a number of options:
```yaml
preprocessors:
- blockdiag:
cache_dir: !path .diagramscache
blockdiag_path: blockdiag
seqdiag_path: seqdiag
actdiag_path: actdiag
nwdiag_path: nwdiag
params:
...
```
`cache_dir`
: Path to the directory with the generated diagrams. It can be a path relative to the project root or a global one; you can use `~/` shortcut.
> **Note**
>
> To save time during build, only new and modified diagrams are rendered. The generated images are cached and reused in future builds.
`*_path`
: Paths to the `blockdiag`, `seqdiag`, `actdiag`, and `nwdiag` binaries. By default, it is assumed that you have these commands in `PATH`, but if they're installed in a custom place, you can define it here.
`params`
: Params passed to the image generation commands (`blockdiag`, `seqdiag`, etc.). Params should be defined by their long names, with dashes replaced with underscores (e.g. `--no-transparency` becomes `no_transparency`); also, `-T` param is called `format` for readability:
preprocessors:
- blockdiag:
params:
antialias: true
font: !path Anonymous_pro.ttf
To see the full list of params, run `blockdiag -h`.
## Usage
To insert a diagram definition in your Markdown source, enclose it between `...`, `...`, `...`, or `...` tags (indentation inside tags is optional):
```markdown
Here's a block diagram:
blockdiag {
A -> B -> C -> D;
A -> E -> F -> G;
}
Here's a sequence diagram:
seqdiag {
browser -> webserver [label = "GET /index.html"];
browser <-- webserver;
browser -> webserver [label = "POST /blog/comment"];
webserver -> database [label = "INSERT comment"];
webserver <-- database;
browser <-- webserver;
}
```
To set a caption, use `caption` option:
```markdown
Diagram with a caption:
blockdiag {
A -> B -> C -> D;
A -> E -> F -> G;
}
```
You can override `params` values from the preprocessor config for each diagram:
```markdown
By default, diagrams are in png. But this diagram is in svg:
blockdiag {
A -> B -> C -> D;
A -> E -> F -> G;
}
```