Adds some docs for the Structurizr static site.

Author: simonbrowndotje

cli/70-building.md

@@ -0,0 +1,51 @@
+---
+layout: default
+title: Building from source
+parent: Structurizr CLI
+nav_order: 70
+permalink: /cli/building
+---
+
+# Building from source
+
+To build the Structurizr CLI from source, you'll need `git` and Java 17+ installed.
+The Structurizr UI is required for the CLI to export a static site, 
+so you will need to additionally clone the [structurizr/ui](https://github.com/structurizr/ui) repo.
+
+## Build
+
+```
+git clone https://github.com/structurizr/cli.git structurizr-cli
+git clone https://github.com/structurizr/ui.git structurizr-ui
+cd structurizr-cli
+./ui.sh
+./gradlew clean build getDeps buildZip
+```
+
+> To use early access/preview features, change the value of `PREVIEW_FEATURES` to `true` in the [Configuration](https://github.com/structurizr/cli/blob/master/src/main/java/com/structurizr/cli/Configuration.java) class.
+
+If you see an error message of the form `Could not find com.structurizr:structurizr-dsl:x.y.z`, you will need to
+[build the Structurizr for Java repo from source, and publish to your local Maven repository](/java/building).
+
+## Run
+
+If successful, The `build/distributions` directory will contain a `structurizr-cli.zip` file.
+To run the Structurizr CLI, you can then:
+
+1. Unzip into a directory of your choice.
+2. Add the directory to your operating system's path (optional).
+3. Use the `structurizr.sh` or `structurizr.bat` file as appropriate for your operating system.
+
+Alternatively you can run the CLI directly from the build directory, with a command like the following:
+
+```
+java -cp "build/libs/*:build/dependencies/*" com.structurizr.cli.StructurizrCliApplication 
+```
+
+## Docker 
+
+To build a Docker image:
+
+```
+docker build . -t mytag
+```

cli/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Structurizr CLI
-nav_order: 17
+nav_order: 18
 has_children: true
 permalink: /cli
 has_toc: false

cli/installation.md

@@ -8,31 +8,13 @@ permalink: /cli/installation
 
 # Installation
 
-## Building from source
-
-To build this repo from the sources (you'll need `git` and Java 17+ installed):
-
-```
-git clone https://github.com/structurizr/cli.git structurizr-cli
-cd structurizr-cli
-./gradlew
-```
-
-If successful, The `build/distributions` directory will contain a `.zip` file, with which you can:
-
-1. Unzip into a directory of your choice.
-2. Add the directory to your operating system's path (optional).
-3. Use the `structurizr.sh` or `structurizr.bat` file as appropriate for your operating system.
-
-
 ## Local installation
 
 1. Download the Structurizr CLI from [https://github.com/structurizr/cli/releases](https://github.com/structurizr/cli/releases), and unzip. You will need Java (version 17+) installed, and available to use from your command line.
 2. Unzip into a directory of your choice.
 3. Add the directory to your operating system's path (optional).
 4. Use the `structurizr.sh` or `structurizr.bat` file as appropriate for your operating system.
 
-
 ## Docker
 
 A prebuilt Docker image is available at [Docker Hub](https://hub.docker.com/r/structurizr/cli). To use it, for example:

contributing.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Contribute
-nav_order: 19
+nav_order: 20
 permalink: /contribute
 ---
 

export/index.md

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Exporters
-nav_order: 18
+nav_order: 19
 has_children: true
 permalink: /export
 has_toc: false

static/01-generating.md

@@ -0,0 +1,27 @@
+---
+layout: default
+title: Generating a static site
+parent: Structurizr static site
+nav_order: 1
+permalink: /static/generating
+---
+
+# Generating a static site
+
+The following CLI commands can be used to generate a static site:
+
+```
+./structurizr.sh export -format static -workspace workspace.dsl -output static
+./structurizr.sh export -format static -workspace workspace.json -output static
+```
+
+## Workspace processing
+
+The export command supports both JSON and DSL workspaces, and processes them in the same way:
+
+- All documentation and decision records are removed from the workspace.
+- Graphviz automatic layout is run on all views that have automatic layout enabled.
+
+The big difference between the JSON and DSL versions of the workspace is that the JSON version has layout information,
+whereas the DSL version doesn't. If you have authored your diagrams with manual layout via Structurizr Lite/on-premises/cloud,
+you will need to use the JSON version of the workspace. If you only use automatic layout, either version will suffice.

static/02-embed.md

@@ -0,0 +1,26 @@
+---
+layout: default
+title: Embedding diagrams
+parent: Structurizr static site
+nav_order: 2
+permalink: /static/embed
+---
+
+# Embedding diagrams
+
+Diagrams in the static site can be embedded via an iframe, with the following code:
+
+```
+<iframe id="structurizrDiagram" src="index.html?iframe=structurizrDiagram#SystemContext" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>
+<script type="text/javascript" src="js/structurizr-embed.js"></script>
+```
+
+- The window hash/anchor can be used to specify which diagram should be embedded.
+- This is a responsive embed, and requires that the `id` of the `iframe` matches the `iframe` parameter of the embed URL.  
+
+## Example
+
+<div style="width: 100%">
+    <iframe id="structurizrDiagram" src="/static/demo/index.html?iframe=structurizrDiagram#SystemContext" width="100%" marginwidth="0" marginheight="0" frameborder="0" scrolling="no" allowfullscreen="true"></iframe>
+    <script type="text/javascript" src="/static/demo/js/structurizr-embed.js"></script>
+</div>