From 3e12fb0738efdd0a1d959ddca4a88f004a1f2811 Mon Sep 17 00:00:00 2001 From: Laurent Rene de Cotret Date: Wed, 18 Sep 2024 07:37:29 -0400 Subject: [PATCH] Preparation for 1.9.0 release --- CHANGELOG.md | 4 + MANUAL.md | 17 ++ docs/MANUAL.html | 533 ++++++++++++++++++++++++++++------------------ docs/index.md | 6 +- pandoc-plot.cabal | 5 +- tools/mkmanual.sh | 3 +- 6 files changed, 349 insertions(+), 219 deletions(-) mode change 100644 => 100755 tools/mkmanual.sh diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e1adda6..aaf815c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ pandoc-plot uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html) +## Release 1.9.0 + +* Added support for [Mermaid](https://mermaid.js.org/), thanks to a contribution by Sanchayan Maity (#74). + ## Release 1.8.0 * Added support for [Asymptote](https://asymptote.sourceforge.io/), thanks to a contribution by Michał J. Gajda (#61). diff --git a/MANUAL.md b/MANUAL.md index 046248b6..84518705 100644 --- a/MANUAL.md +++ b/MANUAL.md @@ -334,6 +334,7 @@ To avoid repetition, `pandoc-plot` can be configured using simple YAML files. Here are **all** the possible parameters: ``` yaml + # This is an example configuration. Everything in this file is optional. # Please refer to the documentation to know about the parameters herein. # @@ -450,16 +451,19 @@ graphviz: executable: dot command_line_arguments: +# The possible parameters for the Bokeh toolkit using Python bokeh: # preamble: bokeh.py executable: python command_line_arguments: +# The possible parameters for the Plots.jl toolkit using Julia plotsjl: # preamble: plotsjl.jl executable: julia command_line_arguments: +# The possible parameters for the PlantUML toolkit plantuml: # preamble: plantuml.txt executable: java @@ -469,6 +473,19 @@ plantuml: # plantuml: # executable: plantuml # command_line_arguments: + +sageplot: + # preamble: sageplot.sage + executable: sage + command_line_arguments: + +d2: + executable: d2 + command_line_arguments: + +mermaid: + executable: mmdc + command_line_arguments: ``` A file like the above sets the **default** values; you can still override them in documents directly. diff --git a/docs/MANUAL.html b/docs/MANUAL.html index a50ca783..2522083d 100644 --- a/docs/MANUAL.html +++ b/docs/MANUAL.html @@ -4,87 +4,179 @@ - pandoc-plot 1.3.0 manual + pandoc-plot 1.9.0 manual - - +code{white-space: pre-wrap;} +span.smallcaps{font-variant: small-caps;} +div.columns{display: flex; gap: min(4vw, 1.5em);} +div.column{flex: auto; overflow-x: auto;} +div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} + +ul.task-list[class]{list-style: none;} +ul.task-list li input[type="checkbox"] { +font-size: inherit; +width: 0.8em; +margin: 0 0.8em 0.2em -1.6em; +vertical-align: middle; +} +.display.math{display: block; text-align: center; margin: 0.5rem auto;} + +pre > code.sourceCode { white-space: pre; position: relative; } +pre > code.sourceCode > span { line-height: 1.25; } +pre > code.sourceCode > span:empty { height: 1.2em; } +.sourceCode { overflow: visible; } +code.sourceCode > span { color: inherit; text-decoration: inherit; } +div.sourceCode { margin: 1em 0; } +pre.sourceCode { margin: 0; } +@media screen { +div.sourceCode { overflow: auto; } +} +@media print { +pre > code.sourceCode { white-space: pre-wrap; } +pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; } +} +pre.numberSource code +{ counter-reset: source-line 0; } +pre.numberSource code > span +{ position: relative; left: -4em; counter-increment: source-line; } +pre.numberSource code > span > a:first-child::before +{ content: counter(source-line); +position: relative; left: -1em; text-align: right; vertical-align: baseline; +border: none; display: inline-block; +-webkit-touch-callout: none; -webkit-user-select: none; +-khtml-user-select: none; -moz-user-select: none; +-ms-user-select: none; user-select: none; +padding: 0 4px; width: 4em; +color: #aaaaaa; +} +pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; } +div.sourceCode +{ } +@media screen { +pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; } +} +code span.al { color: #ff0000; font-weight: bold; } +code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } +code span.at { color: #7d9029; } +code span.bn { color: #40a070; } +code span.bu { color: #008000; } +code span.cf { color: #007020; font-weight: bold; } +code span.ch { color: #4070a0; } +code span.cn { color: #880000; } +code span.co { color: #60a0b0; font-style: italic; } +code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } +code span.do { color: #ba2121; font-style: italic; } +code span.dt { color: #902000; } +code span.dv { color: #40a070; } +code span.er { color: #ff0000; font-weight: bold; } +code span.ex { } +code span.fl { color: #40a070; } +code span.fu { color: #06287e; } +code span.im { color: #008000; font-weight: bold; } +code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } +code span.kw { color: #007020; font-weight: bold; } +code span.op { color: #666666; } +code span.ot { color: #007020; } +code span.pp { color: #bc7a00; } +code span.sc { color: #4070a0; } +code span.ss { color: #bb6688; } +code span.st { color: #4070a0; } +code span.va { color: #19177c; } +code span.vs { color: #4070a0; } +code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } + +
-

pandoc-plot 1.3.0 manual

+

pandoc-plot 1.9.0 manual

- `pandoc-plot` is a [pandoc](https://pandoc.org) filter to generate figures from code blocks in documents. This page is generated [from Markdown](index.md) using `pandoc-plot`, so you can get a sense of what is possible. - [Supported toolkits](#supported-toolkits) @@ -36,7 +33,8 @@ plot-configuration: plot-config.yml - `plotsjl`: plots using the [Julia `Plots.jl`](http://docs.juliaplots.org/latest/) package; - `plantuml`: diagrams using [PlantUML](https://plantuml.com); - `d2`: plots using [D2](https://d2lang.com/); - - `asymptote`: plots using [Asymptote](https://asymptote.sourceforge.io/). + - `asy`: plots using [Asymptote](https://asymptote.sourceforge.io/); + - `mermaid`: plots using the [Mermaid](https://mermaid.js.org/) tookit. ## Simple examples diff --git a/pandoc-plot.cabal b/pandoc-plot.cabal index 29a703a4..c1863e44 100644 --- a/pandoc-plot.cabal +++ b/pandoc-plot.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: pandoc-plot -version: 1.8.0 +version: 1.9.0 synopsis: A Pandoc filter to include figures generated from code blocks using your plotting toolkit of choice. description: A Pandoc filter to include figures generated from code blocks. Keep the document and code in the same location. Output is @@ -21,7 +21,8 @@ tested-with: GHC == 8.10.4, GHC == 9.4.4, GHC == 9.6.1, GHC == 9.6.3, - GHC == 9.8.2 + GHC == 9.8.2, + GHC == 9.10.1 extra-source-files: CHANGELOG.md LICENSE diff --git a/tools/mkmanual.sh b/tools/mkmanual.sh old mode 100644 new mode 100755 index a780c2cf..1d525bc2 --- a/tools/mkmanual.sh +++ b/tools/mkmanual.sh @@ -13,6 +13,7 @@ pandoc-plot write-example-config --help > help-config.txt echo "Creating Markdown manual..." pandoc \ --standalone \ + --embed-resources \ --toc \ --toc-depth=4 \ --metadata version=$version \ @@ -27,7 +28,7 @@ pandoc \ echo "Creating HTML manual..." pandoc \ --standalone \ - --self-contained \ + --embed-resources \ --wrap=preserve \ --metadata title="pandoc-plot $version manual" \ --css=docs/theme.css \