Adds docs for new PNG/SVG export feature.

Author: simonbrowndotje

commands/03-server/21-diagrams/31-scripting.md

@@ -18,10 +18,4 @@ The Structurizr UI provides a small JavaScript API that can be used to script an
 - `exportCurrentDiagramKeyToSVG`: Exports the current diagram key to SVG, and returns the resulting SVG markup.
 - `getViews()`: Gets an array of objects representing the views in the software architecture model.
 - `changeView(viewKey)`: Displays the specified view.
-- `getViewKey()`: Gets the key of the current view.
-
-## Puppeteer
-
-The diagram scripting API can be used in conjunction with tools such as Puppeteer (headless Chrome/Chromium),
-to automate the export of diagrams from the command line, perhaps as a part of a build process.
-The [structurizr-puppeteer repo on GitHub](https://github.com/structurizr/puppeteer) has some code samples of how to do this.
+- `getViewKey()`: Gets the key of the current view.

commands/03-server/23-documentation/04-export.md

@@ -11,12 +11,4 @@ permalink: /server/documentation/export
 
 The documentation export feature will create a single HTML page that includes all documentation currently being displayed. Please note that diagrams with a perspective enabled with not be interactive (you'll be missing the tooltips), and the graph visualisation will be excluded entirely from the export.
 
-## Manual export
-
 When viewing documentation, click the ![HTML filetype](/images/bootstrap-icons/filetype-html.svg) link. This feature may not work if popups are blocked, so please ensure that popups are allowed in your web browser.
-
-## Automated export
-
-Documentation is rendered client-side (i.e. in your web browser), so an automated export is only possible using a web browser
-in conjunction with an automation framework such as headless Chrome and Puppeteer.
-See the [structurizr-puppeteer repo on GitHub](https://github.com/structurizr/puppeteer) for an example script.

commands/03-server/23-documentation/11-scripting.md

@@ -11,10 +11,4 @@ permalink: /server/documentation/scripting
 
 The Structurizr UI provides a small JavaScript API that can be used to script and automate certain tasks. This is available under a JavaScript variable called `structurizr.scripting` when viewing the documentation pages. The following functions are provided:
 
-- `exportDocumentationToOfflineHTMLPage(callback)`: Exports the currently loaded documentation to a single HTML page for offline use. The callback function is called when generation of the HTML page has been finished, and the first function argument is the resulting HTML markup.
-
-## Puppeteer
-
-The diagram scripting API can be used in conjunction with tools such as Puppeteer (headless Chrome/Chromium),
-to automate the export of documentation from the command line, perhaps as a part of a build process.
-The [structurizr-puppeteer repo on GitHub](https://github.com/structurizr/puppeteer) has some code samples of how to do this.
+- `exportDocumentationToOfflineHTMLPage(callback)`: Exports the currently loaded documentation to a single HTML page for offline use. The callback function is called when generation of the HTML page has been finished, and the first function argument is the resulting HTML markup.

commands/03-server/51-workspace-api.md

@@ -59,4 +59,4 @@ curl https://structurizr.example.com/api/workspace/123 -H "X-Authorization: 1234
 
 ## Notes
 
-Please note that diagrams are rendered client-side (i.e. in your web browser), so this API __does not__ provide access to diagrams. An automated export is only possible using a web browser in conjunction with an automation framework such as headless Chrome and Puppeteer. See the [structurizr-puppeteer repo on GitHub](https://github.com/structurizr/puppeteer) for an example script.
+Please note that diagrams are rendered client-side (i.e. in your web browser), so this API __does not__ provide access to diagrams. An automated export is available via the [export PNG/SVG command](/export/png-and-svg).

commands/03-server/71-scripting.md

@@ -27,10 +27,4 @@ The following functions are provided for diagrams:
 
 And the following functions are provided for documentation:
 
-- `exportDocumentationToOfflineHTMLPage(callback)`: Exports the currently loaded documentation to a single HTML page for offline use. The callback function is called when generation of the HTML page has been finished, and the first function argument is the resulting HTML markup.
-
-## Puppeteer
-
-The diagram scripting API can be used in conjunction with tools such as Puppeteer (headless Chrome/Chromium),
-to automate the export of diagrams from the command line, perhaps as a part of a build process.
-The [structurizr-puppeteer repo on GitHub](https://github.com/structurizr/puppeteer) has some code samples of how to do this.
+- `exportDocumentationToOfflineHTMLPage(callback)`: Exports the currently loaded documentation to a single HTML page for offline use. The callback function is called when generation of the HTML page has been finished, and the first function argument is the resulting HTML markup.

commands/04-export/06-png-and-svg.md

@@ -8,11 +8,62 @@ has_children: false
 has_toc: false
 ---
 
+> This feature is currently only available by building from source or using [the preview version of the Java .war file](/binaries#java-war-file).
+
 # PNG and SVG
 
-Structurizr `local` and `server` render PNG/SVG diagrams in your web browser, and therefore exporting these diagrams is not supported from the `export` command.
-PNG/SVG diagram exports can instead be automated using headless Chrome and Puppeteer:
+Exports PNG or SVG images using the Structurizr browser-based renderer from:
+
+- [A running local instance](#local)
+- [A running server instance](#server)
+- [A DSL or JSON file](#dsl-or-json-file)
+
+## local
+
+Export PNG/SVG images from a running [local](/local) instance:
+
+```
+export -format png|svg -url <url> ...
+```
+
+- `url`: The URL must be the _diagrams page_ for the workspace you would like to export (required); for example:
+  - `http://localhost:8080/workspace/1/diagrams` 
+- `-output`: The output directory (optional; default=current working directory)
+- `-mode`: `light` or `dark` colour scheme (optional; default=`light`)
+- `-animation`: `true` to export animation steps, `false` otherwise (optional; default=`false`)
+
+## server
+
+Export PNG/SVG images from a running [server](/server) instance:
+
+```
+export -format png|svg -url <url> ...
+```
+
+- `url`: The URL must be the _unauthenticated diagrams page_ for the workspace you would like to export (required); for example:
+  - `http://structurizr.example.com/workspace/1/diagrams` (server with authentication disabled)
+  - `http://structurizr.example.com/share/1/diagrams` (server with authentication enabled + workspace with public link enabled)
+  - `http://structurizr.example.com/share/1/c2586b8c-91e5-4d62-b490-186112c51565/diagrams` (server with authentication enabled + workspace with sharing link enabled)
+- `-output`: The output directory (optional; default=`.`)
+- `-mode`: `light` or `dark` colour scheme (optional; default=`light`)
+- `-animation`: `true` to export animation steps, `false` otherwise (optional; default=`false`)
+
+## DSL or JSON file
+
+Export PNG/SVG images from a DSL or JSON file:
+
+```
+export -format png|svg -workspace <path> ...
+```
+
+- `workspace`: The path or URL to the workspace DSL/JSON file (required)
+- `-output`: The output directory (optional; default=workspace directory)
+- `-mode`: `light` or `dark` colour scheme (optional; default=`light`)
+- `-animation`: `true` to export animation steps, `false` otherwise (optional; default=`false`)
+
+This will export the specified workspace to a [static site](/export/static-site) and export images from that static site. The same [workspace processing](/export/static-site#workspace-processing) applies as when exporting a static site, so you will need to use a JSON file if you have manual layout.
+
+## Notes
 
-- [server - Diagrams - Scripting](/server/diagrams/scripting)
-- [server - Documentation - Scripting](/server/documentation/scripting)
-- [github.com/structurizr/puppeteer](https://github.com/structurizr/puppeteer) for some example scripts
+- This feature uses the Microsoft Playwright framework to drive a headless version of the Chromium browser, and a version of Chromium will be automatically downloaded the first time. This may take some time.
+- Playwright requires some additional local dependencies to be available, so this feature isn't currently available via the prebuilt `structurizr/structurizr` Docker image.

commands/04-export/index.md

@@ -20,11 +20,12 @@ Structurizr playground, local, and server.
 - -workspace: The path or URL to the workspace JSON/DSL file (required)
 - -format (required):
     - plantuml: the same as `plantuml/structurizr`
-    - [plantuml/structurizr](/export/plantuml): exports views to PlantUML.
-    - [plantuml/c4plantuml](/export/c4plantuml): exports views to C4-PlantUML.
-    - [mermaid](/export/mermaid): exports views to Mermaid.
-    - [websequencediagrams](/export/websequencediagrams): exports dynamic views to WebSequenceDiagrams.
-    - [static](/export/static-site): creates a static HTML site.
+    - [plantuml/structurizr](/export/plantuml): exports views to PlantUML
+    - [plantuml/c4plantuml](/export/c4plantuml): exports views to C4-PlantUML
+    - [mermaid](/export/mermaid): exports views to Mermaid
+    - [websequencediagrams](/export/websequencediagrams): exports dynamic views to WebSequenceDiagrams
+    - [static](/export/static-site): creates a static HTML site
+    - [png|svg](/export/png-and-svg): exports PNG|SVG images, using the Structurizr browser-based renderer
     - json: exports the workspace to the Structurizr JSON format
     - theme: creates a JSON theme based upon the styles and tags defined in the workspace
     - fully qualified class name: provides a way to use a custom exporter (see below)