README.md

February 15, 2026 · View on GitHub

Keadex Battisti Logo

Experiment. Learn. Share.

GitHub Website Website Static Badge


Important

Maintaining open-source solutions demands significant effort, especially since it’s not my primary job. However, Keadex is my passion, and I genuinely enjoy working on it.

If you like Keadex applications or libraries, I’m not asking for a coffee or a donation.
Instead, I'd appreciate if you just ⭐ star this repository and 📣 share it with your teams, colleagues, or community! Thank you!

Introduction

Keadex is a project that aims to experiment, learn and provide open source solutions.

Some of the packages in this repo are experiments ( :microscope: ), some under development ( :hourglass_flowing_sand: ), while others are ready to use open source solutions ( :white_check_mark: ).

💡 Do you have ideas you’d like to share? Are you interested in contributing to Keadex or learning more about it? Feel free to reach out to me on my Discord channel, or explore the Keadex website and documentation for more information!

Packages

Applications

TypePackageShort DescriptionVersionLanguage(s)Framework(s)
:white_check_mark:apps/keadex-battistiKeadex Website & Documentation Platform.GitHub package.json version (subfolder of monorepo)Typescript, MDXNext.js, Nextra, Tailwing CSS
:white_check_mark:apps/keadex-diagramsKeadex architectural diagrams.GitHub package.json version (subfolder of monorepo)PlantUML, JSONKeadex Mina
:white_check_mark:apps/keadex-minaApplication to create and manage C4 Model diagrams.GitHub package.json version (subfolder of monorepo)Typescript, Rust, WasmTauri, React, Tailwind CSS
:white_check_mark:apps/mina-confluence-appCustom Confluence UI integrated into the Confluence Mina plugin.GitHub package.json version (subfolder of monorepo)TypescriptReact, Atlassian Forge

Libraries

TypePackageShort DescriptionVersionLanguage(s)Framework(s)
:white_check_mark:libs/c4-model-ui-kitLibrary that provides UI components to render C4 Model diagrams.GitHub package.json version (subfolder of monorepo)TypescriptFabric.js
:white_check_mark:libs/docusaurus-plugin-minaLibrary that provides the plugin to render Keadex Mina diagrams into Docusaurus.GitHub package.json version (subfolder of monorepo)TypescriptReact, Docusaurus
:white_check_mark:libs/keadex-nx-pluginLibrary that provides the Nx plugin with Keadex executors and generators.GitHub package.json version (subfolder of monorepo)TypescriptNx
:white_check_mark:libs/keadex-ui-kitLibrary that provides UI components to render Keadex applications.GitHub package.json version (subfolder of monorepo)TypescriptReact, Tailwind CSS
:white_check_mark:libs/keadex-utilsLibrary that provides general purpose utilities.GitHub package.json version (subfolder of monorepo)Typescript
:white_check_mark:libs/mina-confluence-pluginLibrary that provides the Confluence Macro to render Keadex Mina diagrams into Confluence.GitHub package.json version (subfolder of monorepo)TypescriptAtlassian Forge
:white_check_mark:libs/mina-cliLibrary that provides the CLI to interact with Mina projects.Dynamic TOML BadgeRust
:white_check_mark:libs/mina-liveLibrary that provides a React component to include Keadex Mina into React apps.GitHub package.json version (subfolder of monorepo)Typescript, Rust, WasmReact, Tailwind CSS
:white_check_mark:libs/mina-reactLibrary that provides a React component to include Keadex Mina diagrams into React apps.GitHub package.json version (subfolder of monorepo)Typescript, Rust, WasmReact, Tailwind CSS

Examples

Warning


Examples are not part of the Yarn workspace. Befor running an example make sure to install the dependencies (yarn install) in the root folder of the example.

PackageDescription
examples/mina-docusaurus-exampleExample to demonstrate how to include in Docusaurus pages, interactive C4 Model diagrams created with Keadex Mina.
examples/mina-live-nextjs-exampleExample to demonstrate how to embed the Keadex Mina application in a Next.js application with the Mina Live component.
examples/mina-react-exampleExample to demonstrate how to integrate the Mina React component to render interactive C4 Model diagrams created with Keadex Mina.

Get Started

This is a monorepo managed with Nx.

To start working on it:

  • clone the repo: git clone https://github.com/keadex/keadex.git
  • install the dependencies: yarn
  • check the project.json file of each application or library for the list of the available Nx targets (commands can be executed - e.g. yarn nx dev keadex-mina)