Markdown editor
readme.md

Paper #

A cross-platform Markdown editor with an Electron/TypeScript interface and a Zig editor engine compiled to WebAssembly.

Requirements #

  • Zig 0.17.0-dev.2375+d8aab4878
  • Node.js 24 and npm
  • A desktop environment supported by Electron

Development currently targets macOS Apple Silicon. Windows and Linux runtime behavior has not yet been verified.

Run #

npm ci
npm start

npm start builds the application and launches Electron. Dependency installation downloads the Electron runtime.

Checks #

npm run check
npm run build
zig build test

Smoke tests:

node_modules/.bin/electron scripts/check_block_editor.cjs

Contributor guides #

  • Architecture: responsibilities, boundaries, and design constraints.
  • Roadmap: product goals and remaining capabilities.
  • UI colors: semantic colors and accessible styling.