semvec/pypi-packages huggingface dataset:
blockdiag-fences 0.0.3
Inline blockdiag images for Markdown with SuperFences
License: MIT
Requires Python: >=3.8,<4.0
Keywords: blockdiag,seqdiag,mkdocs,markdown,superfences

# blockdiag for SuperFences

This provides [blockdiag](http://blockdiag.com/en/blockdiag/index.html) rendering for [Python Markdown](http://pythonhosted.org/Markdown/) through the [SuperFences extension](https://facelessuser.github.io/pymdown-extensions/extensions/superfences/).

It is based on <https://github.com/gisce/markdown-blockdiag>.

## Install

```shell
pip install blockdiag-fences
```

## Use

Wrap your diagram in a code block, tagged with the name of the tool to convert it:


	```blockdiag
	blockdiag {
		A -> B -> C -> D;
		A -> E -> F -> G;
	}
	```

## MkDocs Integration

In your `mkdocs.yml` add this to `markdown_extensions`.

```yaml
markdown_extensions:
  - pymdownx.superfences:
    custom_fences:
      - name: actdiag
        class: actdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: blockdiag
        class: blockdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: nwdiag
        class: nwdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: packetdiag
        class: packetdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: rackdiag
        class: rackdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
      - name: seqdiag
        class: seqdiag
        format: !!python/name:blockdiag_fences.blockdiag.fence_img_format
```