Module documentation for 0.1.4.3
A plugin for
BlogLiterately (http://hackage.haskell.org/package/BlogLiterately) which turns inline diagrams
code into images.
This library also provides an executable,
BlogLiteratelyD, providing a standard instance
BlogLiterately extended with support for
inline diagrams code. For most users it
should suffice to simply use
To use it, include code blocks with the
dia-def class (using pandoc's special extended
or BlogLiterately's extended syntax for tagged
[dia-def] -- This block produces no output but its -- declarations will be in scope in all the -- rest of the diagram blocks. gSq = square 1 # fc green NOTE: Square brackets below should be replaced by curly braces. Haddock chokes on curly braces. Here is a green square: ```[.dia width='200'] dia = gSq ``` Green squares like `gSq`[.dia height='16'] and blue circles like `circle 1 # fc blue`[.dia height='16'] are extremely important.
Note that attributes like width and height can also be specified, but be sure to put the numbers in quotes or else they will not parse properly.
Running this through
replacing square brackets with curly braces)
should result in HTML that looks something like
In addition to simple diagrams,
producing diagrams may also be used. In that
IO action will simply be run, and the
resulting diagram rendered. This can be useful,
for example, when producing a diagram built from
some external data or using randomness.