asciidoctor-diagram 2.2.9 → 2.2.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.adoc +22 -0
  3. data/docs/antora.yml +3 -1
  4. data/docs/modules/ROOT/images/a2s.svg +44 -0
  5. data/docs/modules/ROOT/images/actdiag.png +0 -0
  6. data/docs/modules/ROOT/images/asciidoctor-diagram-process.png +0 -0
  7. data/docs/modules/ROOT/images/barcode.png +0 -0
  8. data/docs/modules/ROOT/images/barcode2.png +0 -0
  9. data/docs/modules/ROOT/images/blockdiag.png +0 -0
  10. data/docs/modules/ROOT/images/d2.png +0 -0
  11. data/docs/modules/ROOT/images/lilypond.png +0 -0
  12. data/docs/modules/ROOT/images/penrose.png +0 -0
  13. data/docs/modules/ROOT/nav.adoc +41 -0
  14. data/docs/modules/ROOT/{partials/create_diagram.adoc → pages/blocks.adoc} +52 -48
  15. data/docs/modules/ROOT/pages/diagram_types/a2s.adoc +47 -0
  16. data/docs/modules/ROOT/pages/diagram_types/actdiag.adoc +46 -0
  17. data/docs/modules/ROOT/pages/diagram_types/barcode.adoc +72 -0
  18. data/docs/modules/ROOT/pages/diagram_types/blockdiag.adoc +38 -0
  19. data/docs/modules/ROOT/pages/diagram_types/bpmn.adoc +21 -0
  20. data/docs/modules/ROOT/pages/diagram_types/bytefield.adoc +16 -0
  21. data/docs/modules/ROOT/pages/diagram_types/d2.adoc +43 -0
  22. data/docs/modules/ROOT/pages/diagram_types/dbml.adoc +16 -0
  23. data/docs/modules/ROOT/pages/diagram_types/diagrams.adoc +20 -0
  24. data/docs/modules/ROOT/pages/diagram_types/ditaa.adoc +31 -0
  25. data/docs/modules/ROOT/pages/diagram_types/dpic.adoc +16 -0
  26. data/docs/modules/ROOT/pages/diagram_types/erd.adoc +17 -0
  27. data/docs/modules/ROOT/pages/diagram_types/gnuplot.adoc +27 -0
  28. data/docs/modules/ROOT/pages/diagram_types/graphviz.adoc +21 -0
  29. data/docs/modules/ROOT/pages/diagram_types/lilypond.adoc +27 -0
  30. data/docs/modules/ROOT/pages/diagram_types/meme.adoc +34 -0
  31. data/docs/modules/ROOT/pages/diagram_types/mermaid.adoc +28 -0
  32. data/docs/modules/ROOT/pages/diagram_types/msc.adoc +23 -0
  33. data/docs/modules/ROOT/pages/diagram_types/nomnoml.adoc +16 -0
  34. data/docs/modules/ROOT/pages/diagram_types/nwdiag.adoc +22 -0
  35. data/docs/modules/ROOT/pages/diagram_types/penrose.adoc +50 -0
  36. data/docs/modules/ROOT/pages/diagram_types/pikchr.adoc +16 -0
  37. data/docs/modules/ROOT/pages/diagram_types/plantuml.adoc +24 -0
  38. data/docs/modules/ROOT/pages/diagram_types/seqdiag.adoc +18 -0
  39. data/docs/modules/ROOT/pages/diagram_types/shaape.adoc +18 -0
  40. data/docs/modules/ROOT/pages/diagram_types/smcat.adoc +18 -0
  41. data/docs/modules/ROOT/pages/diagram_types/structurizr.adoc +29 -0
  42. data/docs/modules/ROOT/pages/diagram_types/svgbob.adoc +21 -0
  43. data/docs/modules/ROOT/pages/diagram_types/symbolator.adoc +19 -0
  44. data/docs/modules/ROOT/pages/diagram_types/syntrax.adoc +28 -0
  45. data/docs/modules/ROOT/pages/diagram_types/tikz.adoc +21 -0
  46. data/docs/modules/ROOT/pages/diagram_types/umlet.adoc +19 -0
  47. data/docs/modules/ROOT/pages/diagram_types/vega.adoc +28 -0
  48. data/docs/modules/ROOT/pages/diagram_types/wavedrom.adoc +17 -0
  49. data/docs/modules/ROOT/pages/enabling.adoc +25 -0
  50. data/docs/modules/ROOT/{partials → pages}/generate.adoc +1 -1
  51. data/docs/modules/ROOT/pages/index.adoc +5 -14
  52. data/docs/modules/ROOT/pages/installation.adoc +32 -0
  53. data/docs/modules/ROOT/pages/output.adoc +19 -0
  54. data/docs/modules/ROOT/partials/shared-attrs.adoc +12 -0
  55. data/docs/modules/ROOT/partials/uris.adoc +2 -0
  56. data/lib/asciidoctor-diagram/barcode/converter.rb +83 -78
  57. data/lib/asciidoctor-diagram/diagram_processor.rb +10 -1
  58. data/lib/asciidoctor-diagram/diagram_source.rb +2 -2
  59. data/lib/asciidoctor-diagram/ditaa/converter.rb +3 -3
  60. data/lib/asciidoctor-diagram/lilypond/converter.rb +2 -2
  61. data/lib/asciidoctor-diagram/penrose/converter.rb +50 -0
  62. data/lib/asciidoctor-diagram/penrose/extension.rb +18 -0
  63. data/lib/asciidoctor-diagram/penrose.rb +8 -0
  64. data/lib/asciidoctor-diagram/plantuml/converter.rb +3 -3
  65. data/lib/asciidoctor-diagram/structurizr/converter.rb +6 -6
  66. data/lib/asciidoctor-diagram/structurizr/structurizr-2.0.3.jar +0 -0
  67. data/lib/asciidoctor-diagram/syntrax/converter.rb +6 -6
  68. data/lib/asciidoctor-diagram/util/java_jruby.rb +4 -0
  69. data/lib/asciidoctor-diagram/util/java_socket.rb +4 -0
  70. data/lib/asciidoctor-diagram/version.rb +1 -1
  71. data/lib/asciidoctor-diagram.rb +1 -0
  72. data/spec/barcode_spec.rb +3 -3
  73. data/spec/d2_spec.rb +1 -1
  74. data/spec/mermaid_spec.rb +0 -37
  75. data/spec/test_helper_methods.rb +4 -1
  76. metadata +56 -8
  77. data/docs/modules/ROOT/partials/advanced.adoc +0 -397
  78. data/docs/modules/ROOT/partials/installation.adoc +0 -19
  79. data/lib/asciidoctor-diagram/structurizr/structurizr-2.0.1.jar +0 -0
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: asciidoctor-diagram
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.9
4
+ version: 2.2.11
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pepijn Van Eeckhoudt
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-29 00:00:00.000000000 Z
11
+ date: 2023-08-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -126,13 +126,58 @@ files:
126
126
  - README.adoc
127
127
  - Rakefile
128
128
  - docs/antora.yml
129
+ - docs/modules/ROOT/images/a2s.svg
130
+ - docs/modules/ROOT/images/actdiag.png
129
131
  - docs/modules/ROOT/images/asciidoctor-diagram-classes.png
130
132
  - docs/modules/ROOT/images/asciidoctor-diagram-process.png
133
+ - docs/modules/ROOT/images/barcode.png
134
+ - docs/modules/ROOT/images/barcode2.png
135
+ - docs/modules/ROOT/images/blockdiag.png
136
+ - docs/modules/ROOT/images/d2.png
137
+ - docs/modules/ROOT/images/lilypond.png
138
+ - docs/modules/ROOT/images/penrose.png
139
+ - docs/modules/ROOT/nav.adoc
140
+ - docs/modules/ROOT/pages/blocks.adoc
141
+ - docs/modules/ROOT/pages/diagram_types/a2s.adoc
142
+ - docs/modules/ROOT/pages/diagram_types/actdiag.adoc
143
+ - docs/modules/ROOT/pages/diagram_types/barcode.adoc
144
+ - docs/modules/ROOT/pages/diagram_types/blockdiag.adoc
145
+ - docs/modules/ROOT/pages/diagram_types/bpmn.adoc
146
+ - docs/modules/ROOT/pages/diagram_types/bytefield.adoc
147
+ - docs/modules/ROOT/pages/diagram_types/d2.adoc
148
+ - docs/modules/ROOT/pages/diagram_types/dbml.adoc
149
+ - docs/modules/ROOT/pages/diagram_types/diagrams.adoc
150
+ - docs/modules/ROOT/pages/diagram_types/ditaa.adoc
151
+ - docs/modules/ROOT/pages/diagram_types/dpic.adoc
152
+ - docs/modules/ROOT/pages/diagram_types/erd.adoc
153
+ - docs/modules/ROOT/pages/diagram_types/gnuplot.adoc
154
+ - docs/modules/ROOT/pages/diagram_types/graphviz.adoc
155
+ - docs/modules/ROOT/pages/diagram_types/lilypond.adoc
156
+ - docs/modules/ROOT/pages/diagram_types/meme.adoc
157
+ - docs/modules/ROOT/pages/diagram_types/mermaid.adoc
158
+ - docs/modules/ROOT/pages/diagram_types/msc.adoc
159
+ - docs/modules/ROOT/pages/diagram_types/nomnoml.adoc
160
+ - docs/modules/ROOT/pages/diagram_types/nwdiag.adoc
161
+ - docs/modules/ROOT/pages/diagram_types/penrose.adoc
162
+ - docs/modules/ROOT/pages/diagram_types/pikchr.adoc
163
+ - docs/modules/ROOT/pages/diagram_types/plantuml.adoc
164
+ - docs/modules/ROOT/pages/diagram_types/seqdiag.adoc
165
+ - docs/modules/ROOT/pages/diagram_types/shaape.adoc
166
+ - docs/modules/ROOT/pages/diagram_types/smcat.adoc
167
+ - docs/modules/ROOT/pages/diagram_types/structurizr.adoc
168
+ - docs/modules/ROOT/pages/diagram_types/svgbob.adoc
169
+ - docs/modules/ROOT/pages/diagram_types/symbolator.adoc
170
+ - docs/modules/ROOT/pages/diagram_types/syntrax.adoc
171
+ - docs/modules/ROOT/pages/diagram_types/tikz.adoc
172
+ - docs/modules/ROOT/pages/diagram_types/umlet.adoc
173
+ - docs/modules/ROOT/pages/diagram_types/vega.adoc
174
+ - docs/modules/ROOT/pages/diagram_types/wavedrom.adoc
175
+ - docs/modules/ROOT/pages/enabling.adoc
176
+ - docs/modules/ROOT/pages/generate.adoc
131
177
  - docs/modules/ROOT/pages/index.adoc
132
- - docs/modules/ROOT/partials/advanced.adoc
133
- - docs/modules/ROOT/partials/create_diagram.adoc
134
- - docs/modules/ROOT/partials/generate.adoc
135
- - docs/modules/ROOT/partials/installation.adoc
178
+ - docs/modules/ROOT/pages/installation.adoc
179
+ - docs/modules/ROOT/pages/output.adoc
180
+ - docs/modules/ROOT/partials/shared-attrs.adoc
136
181
  - docs/modules/ROOT/partials/uris.adoc
137
182
  - examples/Gemfile
138
183
  - examples/README.adoc
@@ -204,6 +249,9 @@ files:
204
249
  - lib/asciidoctor-diagram/nomnoml.rb
205
250
  - lib/asciidoctor-diagram/nomnoml/converter.rb
206
251
  - lib/asciidoctor-diagram/nomnoml/extension.rb
252
+ - lib/asciidoctor-diagram/penrose.rb
253
+ - lib/asciidoctor-diagram/penrose/converter.rb
254
+ - lib/asciidoctor-diagram/penrose/extension.rb
207
255
  - lib/asciidoctor-diagram/pikchr.rb
208
256
  - lib/asciidoctor-diagram/pikchr/converter.rb
209
257
  - lib/asciidoctor-diagram/pikchr/extension.rb
@@ -222,7 +270,7 @@ files:
222
270
  - lib/asciidoctor-diagram/structurizr/converter.rb
223
271
  - lib/asciidoctor-diagram/structurizr/extension.rb
224
272
  - lib/asciidoctor-diagram/structurizr/renderers.rb
225
- - lib/asciidoctor-diagram/structurizr/structurizr-2.0.1.jar
273
+ - lib/asciidoctor-diagram/structurizr/structurizr-2.0.3.jar
226
274
  - lib/asciidoctor-diagram/svgbob.rb
227
275
  - lib/asciidoctor-diagram/svgbob/converter.rb
228
276
  - lib/asciidoctor-diagram/svgbob/extension.rb
@@ -317,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
317
365
  - !ruby/object:Gem::Version
318
366
  version: '0'
319
367
  requirements: []
320
- rubygems_version: 3.4.13
368
+ rubygems_version: 3.2.22
321
369
  signing_key:
322
370
  specification_version: 4
323
371
  summary: A family of Asciidoctor extensions that generate images from a broad range
@@ -1,397 +0,0 @@
1
- == Advanced Usage
2
-
3
- === Enabling Extensions
4
-
5
- In your program, you can either load and register the entire set of diagram extensions
6
-
7
- [source,ruby]
8
- ----
9
- require 'asciidoctor-diagram'
10
- ----
11
-
12
- or load and register each extension individually.
13
-
14
- [source,ruby]
15
- ----
16
- require 'asciidoctor-diagram/<extension_name>'
17
- ----
18
-
19
- `<extension_name>` can be one of `a2s`, `blockdiag`, `bytefield`, `diagrams`, `ditaa`, `dpic`, `erd`, `gnuplot`, `graphviz`, `meme`, `mermaid`, `msc`, `pikchr`, `plantuml`, `shaape`, `smcat`, `svgbob`, `syntrax`, `umlet`, `vega` or `wavedrom`.
20
-
21
- Requiring one or more of these files will automatically register the extensions for all processed documents.
22
-
23
- If you need more fine-grained control over when the extensions are enabled, `asciidoctor-diagram/<extension_name>/extension` can be used instead.
24
- This loads the extensions but does not register it in the Asciidoctor extension registry.
25
- You can then manually register the extensions at the appropriate times using the `Asciidoctor::Extensions` API.
26
-
27
- This document explains the various features of asciidoctor-diagram blocks using ditaa diagrams as an example.
28
-
29
- === Diagram Macros
30
-
31
- The diagram extensions can also be used in inline, or block macro form.
32
-
33
- .Anatomy of a diagram block macro
34
- ----
35
- diagram-type::source-file-name[format=output-format] // <1> <2> <3>
36
- ----
37
- <1> The macro name specifies the diagram syntax that is being used.
38
- <2> The source file name specifies the external file that contains the diagram source code.
39
- <3> The `format` attribute determines the output image format to use. If a format is not specified, the default output format for the chosen diagram type will be used.
40
-
41
- When the source file name is a relative path it is resolved with respect to the location of the document being processed.
42
-
43
- === Image Output Location
44
-
45
- When Asciidoctor Diagram writes images to disk it will go over the following options in order to determine where to write the files.
46
-
47
- . `\{imagesoutdir\}` if the `imagesoutdir` attribute has been specified
48
- . `\{outdir\}/\{imagesdir\}` if the `outdir` attribute has been specified
49
- . `\{to_dir\}/\{imagesdir\}` if the `to_dir` attribute has been specified
50
- . `\{base_dir\}/\{imagesdir\}`
51
-
52
- === Image Cache Location
53
-
54
- The image generation also outputs metadata files that by default are located in `.asciidoctor/diagram`.
55
- To place them in different location, Asciidoctor Diagram checks for (in this order).
56
-
57
- . `\{cachedir\}` attribute is specified in the block header (i.e. `[plantuml, png, cachedir=my-cache]`)
58
- . `\{diagram-cachedir\}` if the `diagram-cachedir` attribute has been specified
59
- . `\{outdir\}/\{imagesdir\}`
60
-
61
- === Specifying Diagram Generator Paths
62
-
63
- Asciidoctor Diagram depends on external tools to generate images.
64
- In most cases it will locate these tools automatically for you by looking for specific executables in each directory in the `PATH` environment variable.
65
- In case you've installed a tool in a way where the executable is not in the `PATH`, you can override its location manually using document attributes.
66
- The following table lists the tools that are required for each diagram type, the location where they can be downloaded and the document attribute you can use to override their locations.
67
-
68
- [cols=">,2*<",options="header"]
69
- |===
70
- |Diagram Type |Tool |Attribute
71
- |a2s |{uri-a2s}[AsciiToSvg] |`a2s`
72
- |actdiag |{uri-actdiag}[ActDiag] |`actdiag`
73
- |blockdiag |{uri-blockdiag}[BlockDiag] |`blockdiag`
74
- |bpmn |{uri-bpmn}[bpmn-js-cmd] |`bpmn`
75
- |bytefield |{uri-bytefield}[bytefield-svg] |`bytefield-svg`
76
- |diagrams |{uri-python}[Python] |`diagrams-python`
77
- |D2 |{uri-d2}[D2] |`d2`
78
- |DBML |{uri-dbml}[dbml-renderer] |`dbml-renderer`
79
- |ditaa |{uri-java}[Java] |`java`
80
- |dpic |{uri-dpic}[dpic] |`dpic`
81
- |erd |{uri-erd}[Erd] or {uri-erd-go}[Erd Go] |`erd`
82
- |gnuplot |{uri-gnuplot}[Gnuplot] |`gnuplot`
83
- |graphviz |{uri-graphviz}[GraphViz] |`dot` or `graphvizdot`
84
- |meme |{uri-imagemagick}[ImageMagick] |`convert` and `identify`
85
- |mermaid |{uri-mermaid}[Mermaid.cli] |`mmdc`
86
- |msc |{uri-mscgen}[Mscgen] or {uri-mscgen-js}[mscgen.js] |`mscgen`
87
- |nomnoml |{uri-nomnoml}[Nomnoml] |`nomnoml`
88
- |nwdiag |{uri-nwdiag}[NwDiag] |`nwdiag`
89
- |packetdiag |{uri-nwdiag}[NwDiag] |`packetdiag`
90
- |pikchr |{uri-pikchr}[Pikchr] |`pikchr`
91
- |plantuml |{uri-java}[Java] |`java`
92
- |rackdiag |{uri-nwdiag}[NwDiag] |`rackdiag`
93
- |seqdiag |{uri-seqdiag}[SeqDiag] |`seqdiag`
94
- |shaape |{uri-shaape}[Shaape] |`shaape`
95
- |smcat |{uri-smcat}[State Machine Cat] |`smcat`
96
- |structurizr |{uri-java}[Java] and {uri-structurizr}[Structurizr CLI] |`java` and the `DIAGRAM_STRUCTURIZRCLI_HOME` environment variable
97
- |svgbob |{uri-svgbob}[SvgBob] |`svgbob`
98
- |symbolator |{uri-symbolator}[Symbolator] |`symbolator`
99
- |syntrax |{uri-syntrax}[Syntrax]/{uri-jsyntrax}[JSyntrax] |`syntrax` or `java` and the `DIAGRAM_JSYNTRAX_HOME` environment variable
100
- |tikz |A TeX distribution that supports {uri-tikz}[TikZ] |`pdflatex` and `pdf2svg`
101
- |umlet |{uri-umlet}[Umlet] |`umlet`
102
- |vega |{uri-vega}[vg2png] and/or {uri-vega}[vg2png] |`vg2png` and `vg2svg`
103
- |vegalite |{uri-vegalite}[vl2vg] and {uri-vega}[vg2png] and/or {uri-vega}[vg2svg]|`vl2vg`, `vg2png` and `vg2svg`
104
- .2+|wavedrom |{uri-wavedromeditor}[WaveDrom Editor] |`wavedrom`
105
- <|{uri-wavedromcli}[WaveDrom CLI] (and {uri-phantomjs}[PhantomJS] for WaveDrom CLI v1) |`wavedrom` (and `phantomjs`)
106
- |===
107
-
108
- If for instance you installed `actdiag` in `/home/me/actdiag/bin` and this path is not included in the `PATH` you can specify its location on the command line
109
-
110
- $ asciidoctor -a actdiag=/home/me/actdiag/bin/actdiag -r asciidoctor-diagram sample.adoc
111
-
112
- [[meme]]
113
- === The Meme Extension
114
-
115
- The meme extension provides a basic '`Advice Animal`' style image generator.
116
- Its usage is easiest to explain with an example.
117
-
118
- ----
119
- meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]
120
- ----
121
-
122
- The target of the block macro tells the extension which image to use as background.
123
- The first two positional attributes are `top` and `bottom` and are used for the top and bottom label.
124
- Occurrences of `//` surrounded by whitespace are interpreted as line breaks.
125
-
126
- [[barcode]]
127
- === The Barcode Extension
128
-
129
- The barcode extension provides barcode rendering.
130
- Barcode macros can be specified using blocks, inline macros or block macros using one of the following templates.
131
-
132
- [source, asciidoc]
133
- ------
134
- // Barcode block
135
- [<type>, <attributes>] <1> <2>
136
- ----
137
- <content> <3>
138
- ----
139
-
140
- // Barcode block macro
141
- <type>::<content>[<attributes>]
142
-
143
- // Barcode inline macro
144
- <type>::<content>[<attributes>]
145
- ------
146
- <1> Type barcode type. One of `bookland`, `codabar`, `code25`, `code25iata`, `code25interleaved`, `code39`, `code93`, `code128`, `code128a`, `code128b`, `code128c`, `ean8`, `ean13`, `gs1_128`, `qrcode`, or `upca`.
147
- <2> Barcode attributes (see the <<barcode_attributes>> attributes section)
148
- <3> The content to encode in the barcode
149
-
150
- By default, the `content` field of the barcode macros will be interpreted as the barcode content.
151
- This works fine for simple barcodes, but for complex data (e.g., a vCard encoded as a QR code) this is not practical.
152
- If the `external` attribute is set on a barcode macro, the target is interpreted as a file path.
153
- The barcode content will then be obtained by reading the contents of the referenced file.
154
-
155
- === Diagram Attributes
156
-
157
- Certain diagram types allow image generation to be customized using attributes.
158
- Each attribute can be specified per individual diagram block or for all blocks of a given diagram type in a document level.
159
- This is illustrated for the blockdiag `fontpath` attribute in the example below.
160
-
161
- ----
162
- = Asciidoctor Diagram
163
- :blockdiag-fontpath: /path/to/font.ttf <1>
164
-
165
- [blockdiag] <2>
166
- ....
167
- ....
168
-
169
- [blockdiag, fontpath="/path/to/otherfont.ttf"] <3>
170
- ....
171
- ....
172
- ----
173
- <1> Attributes can be specified for all diagram of a certain type at the document level by prefixing them with `<blocktype>-`.
174
- In this example, the `fontpath` attribute is specified for all diagrams of type `blockdiag`.
175
- <2> The first diagram does not specify an explicit value for `fontpath` so the global `blockdiag-fontpath` value will be used
176
- <3> The second diagram does specify a `fontpath` value.
177
- This overrides the global `blockdiag-fontpath` value.
178
-
179
- Each attribute can either be specified at the block level or at the document level.
180
- The attribute name at the document level should be prefixed with the diagram type name and a dash.
181
-
182
- ==== Shared Attributes
183
-
184
- The set of shared attributes applies to all diagram types.
185
- The value for these attributes can be defined at the document level for a single diagram type using the diagram type as prefix or for all diagram types using `diagram` as prefix.
186
-
187
- [cols=">,<,<",options="header"]
188
- |===
189
- |Name |Default value |Description
190
- |svg-type |unspecified |One of `static`, `inline` or `interactive`.
191
- This determines the style of SVG embedding that's used in certain backends.
192
- The xref:asciidoc:macros:image-svg.adoc[asciidoc spec] describes this in more detail.
193
- |server-url |unspecified |External service to render diagram.
194
- Usage removes the need to depend on external tools to be installed locally.
195
- |server-type |unspecified |One of `plantuml` or `kroki_io`
196
- |max-get-size |1024 |The maximum size of the URI path for HTTP GET requests.
197
- If the maximum size is exceeded, POST requests are used instead
198
- |===
199
-
200
- ==== AsciiToSVG
201
-
202
- [cols=">,<,<",options="header"]
203
- |===
204
- |Name |Default value |Description
205
- |fontfamily |unspecified |The font family to use in the generated SVG image
206
- |noblur |unspecified |Disable drop-shadow blurring
207
- |===
208
-
209
- [[barcode_attributes]]
210
- ==== Barcode
211
-
212
- [cols=">,<,<",options="header"]
213
- |===
214
- |Name |Default value |Description
215
- |height |100 |The height of the bars. (1D only, 2D uses ydim)
216
- |xdim |1 |The width of the narrowest bar in a barcode. Thicker bars are multiples of the xdim.
217
- |ydim |Same as xdim |This is the same as xdim, but for the height of the blocks in a 2D barcode.
218
- |margin |10 |The width of the quiet zone around the barcode.
219
- |foreground |black |The color of the bars specified as a 3 or 6 digit hex RGB value or HTML color name.
220
- |background |white |The color of the background specified as a 3 or 6 digit hex RGB value or HTML color name.
221
- |===
222
-
223
- ==== Blockdiag
224
-
225
- [cols=">,<,<",options="header"]
226
- |===
227
- |Name |Default value |Description
228
- |fontpath |unspecified |The path to the font that should be used by blockdiag
229
- |===
230
-
231
- ==== BPMN
232
-
233
- [cols=">,<,<",options="header"]
234
- |===
235
- |Name |Default value |Description
236
- |height |786 |The target height of the diagram. Does not apply for output type `svg`.
237
- |width |1024 |The target width of the diagram. Does not apply for output type `svg`.
238
- |===
239
-
240
- ==== D2
241
-
242
- [cols=">,<,<",options="header"]
243
- |===
244
- |Name |Default value |Description
245
- |layout |dagre |Set the diagram layout engine
246
- |theme |0 |Set the diagram theme ID
247
- |pad |100 |Pixels padded around the rendered diagram
248
- |animate-interval| |If given, multiple boards are packaged as 1 SVG which transitions through each board at the interval (in milliseconds). Can only be used with SVG exports.
249
- |sketch |false |Renders the diagram to look like it was sketched by hand
250
- |font-regular |Source Sans Pro Regular |Path to .ttf file to use for the regular font
251
- |font-italic |Source Sans Pro Regular-Italic|Path to .ttf file to use for the italic font
252
- |font-bol |Source Sans Pro Bold |Path to .ttf file to use for the bold font
253
- |===
254
-
255
- ==== DBML
256
-
257
- No specific attributes.
258
-
259
- ==== Diagrams
260
-
261
- No specific attributes.
262
-
263
- ==== Ditaa
264
-
265
- [cols=">,<,<",options="header"]
266
- |===
267
- |Name |Default value |Description
268
- |scale |1 |A scale factor that is applied to the image.
269
- |tabs |8 |An integer value that specifies the tab size as a number of spaces.
270
- |background |FFFFFF |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
271
- |antialias |true |Enables or disables anti-aliasing.
272
- |separation |true |Prevents the separation of common edges of shapes.
273
- |round-corners|false |Causes all corners to be rendered as round corners.
274
- |shadows |true |Enables or disable drop shadows.
275
- |debug |false |Renders the debug grid over the resulting image.
276
- |fixed-slope |false |Makes sides of parallelograms and trapezoids fixed slope instead of fixed width.
277
- |transparent |false |Makes the background of the image transparent instead of using the background color.
278
- |bullet-characters|*o |The characters to recognize as bullets
279
- |===
280
-
281
- ==== Gnuplot
282
-
283
- [cols=">,<,<",options="header"]
284
- |===
285
- |Name |Default value |Description
286
- |background |unspecified |Background color, e.g. `red`, `#FF0000`. Does not work with `txt`.
287
- |height |unspecified |The height of the plot. Must be specified together with `width`.
288
- |width |unspecified |The width of the plot. Must be specified together with `height`.
289
- |crop |unspecified |Trims blank space from the edges of the completed plot (true/false). Does not work with `svg`, `pdf`.
290
- |transparent |unspecified |Generate transparent background (true/false). Does not work with `svg`, `pdf`, `txt`.
291
- |font |unspecified |The font face with optional font size to use for the text, e.g. `font="Arial"`, `font="Arial,11"`. Does not work with `txt`.
292
- |fontscale |unspecified |Scales all label for given factor. Does not work with `txt`.
293
- |===
294
-
295
- ==== GraphViz
296
-
297
- [cols=">,<,<",options="header"]
298
- |===
299
- |Name |Default value |Description
300
- |layout |unspecified |The graphviz layout engine to use (dot -K option).
301
- |===
302
-
303
- ==== Meme
304
-
305
- [cols=">,<,<",options="header"]
306
- |===
307
- |Name |Default value |Description
308
- |fill-color |white |The fill color for the text.
309
- |stroke-color |black |The outline color for the text
310
- |stroke-width |2 |The width of the text outline.
311
- |font |Impact |The font face to use for the text.
312
- |options |unspecified |a comma separate list of flags that modify the image rendering. Currently only `noupcase` is supported which disable upper casing the labels.
313
- |===
314
-
315
- ==== Mermaid
316
-
317
- [cols=">,<,<",options="header"]
318
- |===
319
- |Name |Default value |Description
320
- |background |FFFFFF |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
321
- |css |unspecified |Path to a CSS file to pass to mermaid.
322
- |config |unspecified |Path to a JSON config file to pass to mermaid.
323
- |gantt-config |unspecified |Path to a gantt config file to pass to mermaid.
324
- |puppeteer-config|unspecified |Path to a puppeteer config file to pass to mermaid.
325
- |sequence-config |unspecified |Path to a sequence config file to pass to mermaid.
326
- |theme |unspecified |Theme of the chart, could be default, forest, dark or neutral.
327
- |width |unspecified |Width of the page.
328
- |height |unspecified |Height of the page.
329
- |===
330
-
331
- ==== Msc
332
-
333
- [cols=">,<,<",options="header"]
334
- |===
335
- |Name |Default value |Description
336
- |font |unspecified |The name of the font that should be used by mscgen
337
- |===
338
-
339
- ==== PlantUML
340
-
341
- [cols=">,<,<",options="header"]
342
- |===
343
- |Name |Default value |Description
344
- |config |unspecified |Path to a config file to pass to PlantUML.
345
- |theme |unspecified |PlantUML theme to use.
346
- |size-limit |4096 |The maximum dimensions (width and height) of generated diagrams.
347
- |includedir |unspecified |sets a common directory for puml includes (plantuml.include.path)
348
- |preprocess |true |Preprocess PlantUML code before rendering the diagram.
349
- |===
350
-
351
- ==== State Machine Cat
352
-
353
- [cols=">,<,<",options="header"]
354
- |===
355
- |Name |Default value |Description
356
- |direction |unspecified |The direction of the state machine diagram. One of `top-down`, `bottom-top`, `left-right` or `right-left`.
357
- |engine |unspecified |The layout engine to use. One of `dot`, `circo`, `fdp`, `neato`, `osage`, or `twopi`
358
- |===
359
-
360
- ==== Structurizr
361
-
362
- [cols=">,<,<",options="header"]
363
- |===
364
- |Name |Default value |Description
365
- |renderer |plantuml-c4 |The rendering backend to use. One of `d2`, `graphviz`, `mermaid`, `plantuml`, or `plantuml-c4`
366
- |view |unspecified |The key of the view to render
367
- |===
368
-
369
- ==== svgbob
370
-
371
- [cols=">,<,<",options="header"]
372
- |===
373
- |Name |Default value |Description
374
- |font-family |arial |text will be rendered with this font
375
- |font-size |14 |text will be rendered with this font size
376
- |scale |1 |scale the entire svg (dimensions, font size, stroke width) by this factor
377
- |stroke-width |2 |stroke width for all lines
378
- |===
379
-
380
- ==== Syntrax
381
-
382
- [cols=">,<,<",options="header"]
383
- |===
384
- |Name |Default value |Description
385
- |heading |unspecified |Diagram title
386
- |scale |1 |A scale factor that is applied to the image.
387
- |style-file |unspecified |Path to a style config file to pass to Syntrax.
388
- |transparent |false |Makes the background of the image transparent instead of opaque white.
389
- |===
390
-
391
- ==== TikZ
392
-
393
- [cols=">,<,<",options="header"]
394
- |===
395
- |Name |Default value |Description
396
- |preamble |unspecified |Code definitions to pass to TikZ.
397
- |===
@@ -1,19 +0,0 @@
1
- == Installation
2
-
3
- Asciidoctor Diagram is a RubyGem, which can be installed using the `gem` or `bundle` commands.
4
-
5
- You can install the Asciidoctor Diagram gem by typing `gem install` in the CLI.
6
-
7
- $ gem install asciidoctor-diagram
8
-
9
- by first adding the following entry to your project's [.path]_Gemfile_.
10
-
11
- .Gemfile
12
- [source,ruby]
13
- ----
14
- gem 'asciidoctor-diagram'
15
- ----
16
-
17
- Then execute `bundle` in the CLI.
18
-
19
- $ bundle