// ZMAX — DOCUMENTATION

A modal IDE in Rust, with an Emacs / Spacemacs-style command and keybinding port.

>_ZMAX

A modal IDE in Rust, with an Emacs / Spacemacs-style command and keybinding port. This page is the documentation home served at the GitHub Pages site root. Browse the generated coverage reports, the engineering report, and the project docs below.

13
Workspace Crates
334
Configured Languages
3,129
Ported Commands
3
Live Reports

~HOST INTEGRATION

zmax plugs into the wider MenkeTechnologies terminal stack.

zwire colorscheme sync

With sync-zwire-theme = true, zmax bidirectionally syncs its colorscheme with the zwire terminal host: a native file watcher on ~/.zwire/global.toml re-applies the matching zgui-<scheme> theme the instant zwire's scheme changes (no keypress), and committing a theme in-editor writes the scheme back for the browser and HUD to follow. See themes.md.


~REPORTS

Live, source-derived reports. The port and keybinding reports are auto-generated by scripts/gen_port_report.py on every run.

Engineering Report

report.html — workspace module map, dependency footprint, scripting embeds, language/grammar coverage, and test inventory, counted directly from the Rust source tree.

Port Report

port_report.html — coverage of Emacs / Vim / Spacemacs commands ported into zmax, with evidence and a re-derived numerator.

Keybinding Coverage

keybinding_report.html — the key-press subset of the port report: which bindings are ported, partial, or pending.


~PROJECT DOCS

Narrative documentation for goals, structure, releases, and contribution.

DocumentSummary
vision.mdGoals and the overall direction of the project.
architecture.mdHow the editor is structured.
releases.mdRelease notes and history.
CONTRIBUTING.mdHow to build and contribute.

~SOURCE

Source & issues: github.com/MenkeTechnologies/zmax. The port and keybinding reports are auto-generated by scripts/gen_port_report.py.