structurizr-site-generatr
Static site generator for architecture models created with Structurizr DSL
File Explorer
Download Latest Version (.zip)- pr.yml
- release.yml
- all unit tests.run.xml
- generate site for example model (from git repo all branches) .run.xml
- generate site for example model (from git repo).run.xml
- generate site for example model (local).run.xml
- serve example model.run.xml
- nice-picture.png
- custom.css
- favicon.ico
- logo.png
- atm-example.png
- 0001-record-architecture-decisions.md
- 0001-record-architecture-decisions.md
- 0002-implement-feature-1.md
- 0003-another-realisation-of-feature-1.md
- 0001-inner-workings.md
- 0001-record-architecture-decisions.md
- 0000-introduction.md
- 0001-inner-workings.md
- 0004-using-oracle-database-schema.md
- 0002-guide.md
- 0000-introduction.md
- 0001-history.md
- 0002-guide.md
- database-erd-example.jpg
- uml-class-diagram.png
- 0001-record-architecture-decisions.md
- 0002-implement-feature-1.md
- 0003-another-realisation-of-feature-1.md
- 0004-using-oracle-database-schema.md
- 00-index.md
- 01-embedding-diagrams-and-images.md
- 02-markdown-features.md
- 03-asciidoc-features.adoc
- .adr-dir
- workspace.dsl
- gradle-wrapper.jar
- gradle-wrapper.properties
- Document.kt
- Home.kt
- SoftwareSystemComponents.kt
- SoftwareSystemContainerDecisions.kt
- SoftwareSystemContainers.kt
- SoftwareSystemContainerSections.kt
- SoftwareSystemContext.kt
- SoftwareSystemDecisions.kt
- SoftwareSystemHome.kt
- SoftwareSystemRelationships.kt
- SoftwareSystemSections.kt
- WorkspaceDecisions.kt
- WorkspaceSections.kt
- Asciidoctor.kt
- BranchHomeLinkViewModel.kt
- ComponentsTabViewModel.kt
- ComponentTabViewModel.kt
- ContainersCodeTabViewModel.kt
- ContainersComponentTabViewModel.kt
- ContainerTabViewModel.kt
- ContentText.kt
- ContentTitle.kt
- CustomStylesheetViewModel.kt
- DecisionsTableViewModel.kt
- DecisionTabViewModel.kt
- DiagramIndexViewModel.kt
- DiagramViewModel.kt
- ExternalLinkViewModel.kt
- FaviconViewModel.kt
- FlexmarkConfig.kt
- HeaderBarViewModel.kt
- HomePageViewModel.kt
- ImageViewModel.kt
- ImageViewViewModel.kt
- LinkViewModel.kt
- MenuNodeViewModel.kt
- MenuViewModel.kt
- PageViewModel.kt
- PropertiesTableViewModel.kt
- SearchViewModel.kt
- SectionsTableViewModel.kt
- SectionTabViewModel.kt
- SoftwareSystemContainerComponentCodePageViewModel.kt
- SoftwareSystemContainerComponentDecisionPageViewModel.kt
- SoftwareSystemContainerComponentDecisionsPageViewModel.kt
- SoftwareSystemContainerComponentSectionPageViewModel.kt
- SoftwareSystemContainerComponentSectionsPageViewModel.kt
- SoftwareSystemContainerComponentsPageViewModel.kt
- SoftwareSystemContainerDecisionPageViewModel.kt
- SoftwareSystemContainerDecisionsPageViewModel.kt
- SoftwareSystemContainerPageViewModel.kt
- SoftwareSystemContainerSectionPageViewModel.kt
- SoftwareSystemContainerSectionsPageViewModel.kt
- SoftwareSystemContextPageViewModel.kt
- SoftwareSystemDecisionPageViewModel.kt
- SoftwareSystemDecisionsPageViewModel.kt
- SoftwareSystemDependenciesPageViewModel.kt
- SoftwareSystemDeploymentPageViewModel.kt
- SoftwareSystemDynamicPageViewModel.kt
- SoftwareSystemHomePageViewModel.kt
- SoftwareSystemPageViewModel.kt
- SoftwareSystemSectionPageViewModel.kt
- SoftwareSystemSectionsPageViewModel.kt
- SoftwareSystemsPageViewModel.kt
- SoftwareSystemTableUtilities.kt
- TableViewModel.kt
- Theme.kt
- ToHtml.kt
- WorkspaceDecisionPageViewModel.kt
- WorkspaceDecisionsPageViewModel.kt
- WorkspaceDocumentationSectionPageViewModel.kt
- AutoReloading.kt
- CDN.kt
- ContentDiv.kt
- Diagram.kt
- DiagramIndex.kt
- ExternalLink.kt
- Favicon.kt
- HomePage.kt
- Image.kt
- Link.kt
- MarkdownExtension.kt
- Menu.kt
- Modal.kt
- Page.kt
- PageHeader.kt
- RawHtml.kt
- RedirectRelative.kt
- RedirectUpPage.kt
- SearchPage.kt
- SoftwareSystemContainerComponentCodePage.kt
- SoftwareSystemContainerComponentDecisionPage.kt
- SoftwareSystemContainerComponentDecisionsPage.kt
- SoftwareSystemContainerComponentSectionPage.kt
- SoftwareSystemContainerComponentSectionsPage.kt
- SoftwareSystemContainerComponentsPage.kt
- SoftwareSystemContainerDecisionPage.kt
- SoftwareSystemContainerDecisionsPage.kt
- SoftwareSystemContainerPage.kt
- SoftwareSystemContainerSectionPage.kt
- SoftwareSystemContainerSectionsPage.kt
- SoftwareSystemContextPage.kt
- SoftwareSystemDecisionPage.kt
- SoftwareSystemDecisionsPage.kt
- SoftwareSystemDependenciesPage.kt
- SoftwareSystemDeploymentPage.kt
- SoftwareSystemDynamicPage.kt
- SoftwareSystemHomePage.kt
- SoftwareSystemPage.kt
- SoftwareSystemSectionPage.kt
- SoftwareSystemSectionsPage.kt
- SoftwareSystemsPage.kt
- Table.kt
- WorkspaceDecisionPage.kt
- WorkspaceDecisionsPage.kt
- WorkspaceDocumentationSectionPage.kt
- DateFormatter.kt
- DiagramGenerator.kt
- GeneratorContext.kt
- PlantUmlExporter.kt
- RelativeUrl.kt
- SiteGenerator.kt
- App.kt
- ClonedRepository.kt
- CreateStructurizrWorkspace.kt
- GenerateSiteCommand.kt
- ServeCommand.kt
- StringUtilities.kt
- StructurizrUtilities.kt
- VersionCommand.kt
- admonition.css
- style.css
- treeview.css
- admonition.js
- auto-reload.js
- header.js
- katex-render.js
- modal.js
- reformat-mermaid.js
- search.js
- svg-modal.js
- toggle-theme.js
- treeview.js
- DecisionPageTestHelper.kt
- DecisionsPageTestHelper.kt
- SoftwareSystemContainerComponentDecisionPageTest.kt
- SoftwareSystemContainerComponentDecisionsPageTest.kt
- SoftwareSystemContainerDecisionPage.kt
- SoftwareSystemContainerDecisionsPageTest.kt
- SoftwareSystemDecisionPageTest.kt
- SoftwareSystemDecisionsPageTest.kt
- WorkspaceDecisionPageTest.kt
- WorkspaceDecisionsPageTest.kt
- SectionPageTestHelper.kt
- SectionsPageTestHelper.kt
- SoftwareSystemContainerComponentSectionPageTest.kt
- SoftwareSystemContainerComponentSectionsPageTest.kt
- SoftwareSystemContainerSectionPageTest.kt
- SoftwareSystemContainerSectionsPageTest.kt
- SoftwareSystemSectionPageTest.kt
- SoftwareSystemSectionsPageTest.kt
- E2ETestFixture.kt
- PageTestHelper.kt
- RetryExtension.kt
- SearchPageTest.kt
- SoftwareSystemDependenciesPageTest.kt
- SoftwareSystemHomePageTest.kt
- SoftwareSystemsPageTest.kt
- WorkspaceHomePageTest.kt
- AsciidocToHtmlTest.kt
- BranchHomeLinkViewModelTest.kt
- ContentTextTest.kt
- ContentTitleTest.kt
- CustomStylesheetViewModelTest.kt
- DecisionsTableViewModelTest.kt
- DecisionTabViewModelTest.kt
- DiagramIndexViewModelTest.kt
- FaviconViewModelTest.kt
- HeaderBarViewModelTest.kt
- HomePageViewModelTest.kt
- ImageViewModelTest.kt
- ImageViewViewModelTest.kt
- IndexingTest.kt
- LinkViewModelTest.kt
- MarkdownToHtmlTest.kt
- MenuViewModelTest.kt
- PageViewModelTest.kt
- PropertiesTableViewModelTest.kt
- SearchViewModelTest.kt
- SoftwareSystemContainerComponentCodePageViewModelTest.kt
- SoftwareSystemContainerComponentDecisionPageViewModelTest.kt
- SoftwareSystemContainerComponentDecisionsPageViewModelTest.kt
- SoftwareSystemContainerComponentSectionPageViewModelTest.kt
- SoftwareSystemContainerComponentSectionsPageViewModelTest.kt
- SoftwareSystemContainerComponentsPageViewModelTest.kt
- SoftwareSystemContainerDecisionPageViewModelTest.kt
- SoftwareSystemContainerDecisionsPageViewModelTest.kt
- SoftwareSystemContainerPageViewModelTest.kt
- SoftwareSystemContainerSectionPageViewModelTest.kt
- SoftwareSystemContainerSectionsPageViewModelTest.kt
- SoftwareSystemContextPageViewModelTest.kt
- SoftwareSystemDecisionPageViewModelTest.kt
- SoftwareSystemDecisionsPageViewModelTest.kt
- SoftwareSystemDependenciesPageViewModelTest.kt
- SoftwareSystemDeploymentPageViewModelTest.kt
- SoftwareSystemDynamicPageViewModelTest.kt
- SoftwareSystemHomePageViewModelTest.kt
- SoftwareSystemPageViewModelTest.kt
- SoftwareSystemSectionPageViewModelTest.kt
- SoftwareSystemSectionsPageViewModelTest.kt
- SoftwareSystemsPageViewModelTest.kt
- TableViewModelTest.kt
- ViewModelTest.kt
- WorkspaceDecisionPageViewModelTest.kt
- WorkspaceDecisionsPageViewModelTest.kt
- WorkspaceDocumentationSectionPageViewModelTest.kt
- CDNTest.kt
- BranchComparatorTest.kt
- PlantUmlExporterTest.kt
- StringUtilitiesTest.kt
- StructurizrUtilitiesTest.kt
- .dockerignore
- .editorconfig
- .gitattributes
- .gitignore
- .markdownlint.json
- .prettierrc
- .tool-versions
- build.gradle.kts
- CONTRIBUTING.md
- cosign.pub
- Dockerfile
- gradlew
- gradlew.bat
- LICENSE
- package.json
- README.md
- renovate.json
- settings.gradle.kts
# Installation Guide
1. Get the code
git clone https://github.com/avisi-cloud/structurizr-site-generatr
Downloads the entire project code from GitHub to your computer.
cd structurizr-site-generatr
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
brew tap avisi-cloud/tools
Registers this project's repository (tap) with Homebrew.
brew install structurizr-site-generatr
Installs the pre-built package via Homebrew โ no source build required.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull ghcr.io/avisi-cloud/structurizr-site-generatr
Type this command into your terminal and run it.
docker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr --help
Runs the built image as an actual container.
docker> docker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr --help
Runs the built image as an actual container.
docker> docker run -it --rm ghcr.io/avisi-cloud/structurizr-site-generatr version
Runs the built image as an actual container.
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr generate-site --workspace-file workspace.dsl --assets-dir assets
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
4. Gradle (Java/Kotlin)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java/Kotlin projects.
- Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build
Builds the project using Gradle.
A BUILD SUCCESSFUL message means it worked. The output is created under build/.
5. Node.js
EasyPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)