Documentation improvements

asciidoctor · Jun 16, 2023 · c406e30 · c406e30
1 parent 276fbaf
commit c406e30
Show file tree

Hide file tree

Showing 15 changed files with 53 additions and 32 deletions.
diff --git a/docs/modules/ROOT/images/d2.png b/docs/modules/ROOT/images/d2.png
diff --git a/docs/modules/ROOT/pages/diagram_types/a2s.adoc b/docs/modules/ROOT/pages/diagram_types/a2s.adoc
@@ -3,11 +3,6 @@ include::partial$uris.adoc[]
 
 {uri-a2s}[ASCIIToSVG] is a pretty simple Go library (with an accompanying CLI tool) that parses ASCII art diagrams, attempting to convert them to an aesthetically pleasing SVG output.
 
-== Installation
-
-- Install the https://go.dev[Go] runtime
-- Run `go install github.com/asciitosvg/asciitosvg@latest`
-
 == Example
 
 ----
@@ -27,9 +22,14 @@ include::partial$uris.adoc[]
 
 image::a2s.svg[]
 
+== Installation
+
+- Install the https://go.dev[Go] runtime
+- Run `go install github.com/asciitosvg/asciitosvg@latest`
+
 == Supported Image Formats
 
-- SVG
+- SVG (default)
 - TXT
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/actdiag.adoc b/docs/modules/ROOT/pages/diagram_types/actdiag.adoc
@@ -3,11 +3,6 @@ include::partial$uris.adoc[]
 
 {uri-actdiag}[actdiag] generates activity-diagram images from .diag files (similar to graphviz’s DOT files).
 
-== Installation
-
-- A Python runtime is required
-- Follow the http://blockdiag.com/en/actdiag/introduction.html#setup[actdag installation instructions]
-
 == Example
 
 ----
@@ -30,10 +25,15 @@ actdiag {
 
 image::actdiag.png[]
 
+== Installation
+
+- A Python runtime is required
+- Follow the http://blockdiag.com/en/actdiag/introduction.html#setup[actdag installation instructions]
+
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/barcode.adoc b/docs/modules/ROOT/pages/diagram_types/barcode.adoc
@@ -27,15 +27,6 @@ This works fine for simple barcodes, but for complex data (e.g., a vCard encoded
 If the `external` attribute is set on a barcode macro, the target is interpreted as a file path.
 The barcode content will then be obtained by reading the contents of the referenced file.
 
-== Installation
-
-- All barcodes types except QR codes require the https://rubygems.org/gems/barby[barby Ruby gem]
-- QR codes requires the https://rubygems.org/gems/rqrcode[rqrcode Ruby gem]
-- PNG image output requires the https://rubygems.org/gems/chunky_png[chunky_png gem]
-
-Each of these dependencies will automatically get loaded as needed.
-It is not necessary to require these manually using the `-r` Asciidoctor CLI option.
-
 == Example
 
 ----
@@ -51,10 +42,19 @@ Barcode can be written image:barcode.png[] inline or as blocks.
 
 image::barcode2.png[]
 
+== Installation
+
+- All barcodes types except QR codes require the https://rubygems.org/gems/barby[barby Ruby gem]
+- QR codes requires the https://rubygems.org/gems/rqrcode[rqrcode Ruby gem]
+- PNG image output requires the https://rubygems.org/gems/chunky_png[chunky_png gem]
+
+Each of these dependencies will automatically get loaded as needed.
+It is not necessary to require these manually using the `-r` Asciidoctor CLI option.
+
 == Supported Image Formats
 
 - PNG
-- SVG
+- SVG (default)
 - TXT
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/blockdiag.adoc b/docs/modules/ROOT/pages/diagram_types/blockdiag.adoc
@@ -17,10 +17,15 @@ blockdiag {
 
 image::blockdiag.png[]
 
+== Installation
+
+- A Python runtime is required
+- Follow the http://blockdiag.com/en/blockdiag/introduction.html#setup[blockdiag installation instructions]
+
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/bpmn.adoc b/docs/modules/ROOT/pages/diagram_types/bpmn.adoc
@@ -7,7 +7,7 @@ This extension uses {uri-bpmn}[bpmn-js-cmd] to render diagrams
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/d2.adoc b/docs/modules/ROOT/pages/diagram_types/d2.adoc
@@ -5,6 +5,21 @@ include::partial$uris.adoc[]
 It stands for Declarative Diagramming.
 Declarative, as in, you describe what you want diagrammed, it generates the image.
 
+== Example
+
+----
+[d2]
+....
+donut: {shape: circle}
+database.shape: cylinder
+you: {
+  shape: person
+}
+....
+----
+
+image::d2.png[]
+
 == Supported Image Formats
 
 - PDF

diff --git a/docs/modules/ROOT/pages/diagram_types/diagrams.adoc b/docs/modules/ROOT/pages/diagram_types/diagrams.adoc
@@ -8,7 +8,7 @@ You can also describe or visualize the existing system architecture as well.
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/ditaa.adoc b/docs/modules/ROOT/pages/diagram_types/ditaa.adoc
@@ -7,7 +7,7 @@ A https://github.com/pepijnve/ditaa[fork of the ditaa] project is bundled with t
 
 == Supported Image Formats
 
-- PNG
+- PNG (default)
 - SVG
 - TXT
 

diff --git a/docs/modules/ROOT/pages/diagram_types/erd.adoc b/docs/modules/ROOT/pages/diagram_types/erd.adoc
@@ -5,7 +5,7 @@ include::partial$uris.adoc[]
 
 == Supported Image Formats
 
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/gnuplot.adoc b/docs/modules/ROOT/pages/diagram_types/gnuplot.adoc
@@ -7,7 +7,7 @@ It can be used interactively to plot functions and data points in both two- and
 == Supported Image Formats
 
 - GIF
-- PNG
+- PNG (default)
 - SVG
 - TXT
 

diff --git a/docs/modules/ROOT/pages/diagram_types/graphviz.adoc b/docs/modules/ROOT/pages/diagram_types/graphviz.adoc
@@ -7,7 +7,8 @@ Graphviz has many useful features for concrete diagrams, such as options for col
 == Supported Image Formats
 
 - GIF
-- PNG
+- PNG (default)
+- SVG
 
 == Attributes
 

diff --git a/docs/modules/ROOT/pages/diagram_types/meme.adoc b/docs/modules/ROOT/pages/diagram_types/meme.adoc
@@ -17,7 +17,7 @@ The meme extension requires https://imagemagick.org[ImageMagick].
 == Supported Image Formats
 
 - GIF
-- PNG
+- PNG (default)
 
 == Attributes
 

diff --git a/docs/modules/ROOT/pages/diagram_types/nwdiag.adoc b/docs/modules/ROOT/pages/diagram_types/nwdiag.adoc
@@ -8,7 +8,7 @@ The `rackdiag` and `packetdiag` tools that are part of the `nwdiag` package are
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes

diff --git a/docs/modules/ROOT/pages/diagram_types/seqdiag.adoc b/docs/modules/ROOT/pages/diagram_types/seqdiag.adoc
@@ -6,7 +6,7 @@ include::partial$uris.adoc[]
 == Supported Image Formats
 
 - PDF
-- PNG
+- PNG (default)
 - SVG
 
 == Attributes