Markdown workspace platform
MdWrk is a multi-package workspace for markdown authoring, rendering, in-place editing, extension runtime delivery, lander publishing, and repository governance.
The repo is organized like the strongest public package READMEs: start with the product promise, show how to install and run it quickly, then make the package graph and docs easy to navigate. This README is the front door for the repo, not just a file inventory.
- Application surfaces for the MdWrk client, desktop shell, and public marketing site.
- Reusable renderer, editor, shared, contract, extension, lander, and content packages under the
@mdwrkscope. - Governed documentation, SSOT specs, conformance scripts, release tooling, and generated evidence lanes.
- Example apps that validate public package consumption outside the first-party apps.
Node.js 20.x through 22.x, matching the workspace engine contract in the root package manifest.
npm install
npm run buildUse the workspace root when you want the full platform:
npm run dev:client
npm run dev:mdwrkcom
npm run test
npm run conformanceStart from the package indexes below when you want one surface instead of the whole repo.
apps/contains deployable surfaces.packages/contains reusable libraries grouped by family.docs/contains architecture, conformance, and release guidance.tools/contains the automation that keeps the repo reproducible and certifiable.examples/proves the package API shape from an external-consumer perspective.
- Apps - client app entrypoint
- Desktop Shell - Electron and Capacitor wrapper
- Public Site - mdwrk.com app
- Packages Index - all reusable package families
- Docs Index - architecture, conformance, and operations
- Examples - public package consumption examples
- Tooling - CI, release, and governance scripts
- npm org - published package scope