mmdflux 2.1.0

Render Mermaid diagrams as Unicode text, ASCII, SVG, and MMDS JSON.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Developer Setup

## Prerequisites

Install the following tools before working on mmdflux:

| Tool | Purpose | Install |
|------|---------|---------|
| [Rust](https://rustup.rs/) (stable + nightly) | Build, test, format | `rustup install stable nightly` |
| [just](https://github.com/casey/just) | Task runner | `cargo install just` or `brew install just` |
| [cargo-nextest](https://nexte.st/) | Parallel test runner | `cargo install cargo-nextest` |
| [cocogitto](https://docs.cocogitto.io/) 6.5.0 | Conventional Commits enforcement | `cargo install cocogitto@6.5.0` |

Optional (for specific workflows):

| Tool | Purpose | Install |
|------|---------|---------|
| [wasm-pack](https://rustwasm.github.io/wasm-pack/) | WebAssembly builds | `cargo install wasm-pack` |
| [Node.js](https://nodejs.org/) | Dagre debug scripts, web playground | via nvm or brew |
| [cargo-edit](https://github.com/killercup/cargo-edit) | `cargo set-version` used by release hooks | `cargo install cargo-edit` |
| [gh](https://cli.github.com/) | GitHub CLI for CI checks and release assets | `brew install gh` |

## First-time setup

```bash
# Clone the repo
git clone git@github.com:kevinswiber/mmdflux.git
cd mmdflux

# Install git hooks (enforces Conventional Commits)
just setup-hooks

# Verify everything works
just check
```

## Commit conventions

This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). The `commit-msg` hook validates messages automatically via cocogitto.

Format: `<type>(<optional scope>): <description>`

Types: `feat`, `fix`, `chore`, `docs`, `refactor`, `test`, `ci`, `perf`, `style`, `build`

For non-trivial changes, include a body after a blank line explaining **what** changed and **why**.

## Day-to-day commands

Run `just` to see all available recipes. The most common:

```bash
just test              # Run all tests
just lint              # Clippy + fmt check
just check             # Lint + test + architecture
just fmt               # Format code
just run diagram.mmd   # Run the CLI
```

See the [Justfile](../../Justfile) for the full list.