Quick Start

1. Create a Structurizr workspace in a .maniok folder at the root of your repository. .maniok/workspace.dsl is the entrypoint to the documentation.
   • You can also run the Maniok Architecture Prompt in your repository to generate a C4 model from your codebase as a starting point.
2. Pull & run the Maniok-Preview Docker image, replacing `PATH` with the path to the created .maniok folder

   docker pull ghcr.io/danischuetz/maniok/maniok-preview:latest

   docker tag ghcr.io/danischuetz/maniok/maniok-preview maniok-preview

   docker run -t --rm -p 8080:8080 -v PATH:/usr/workspace maniok-preview:latest

3. Open the URL http://localhost:8080 in your browser and start editing. Maniok-Preview automatically exports your workspace and supports hot-reload! 🚀
4. Optional: Publish the changes and view/share the documentation through https://app.maniok.io (public repositories only atm)