The git-native solution for C4 architecture documentation.

Quick Start

  1. Run the Maniok Architecture Prompt in your repository to generate a C4 model from your codebase
  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)