Standalone Modules

Primary packages

The main package surfaces are:

  • @mdwrk/mdwrkspace for the full reusable workspace client
  • @mdwrk/markdown-editor-react for the editor surface
  • @mdwrk/markdown-renderer-react for the React renderer surface
  • @mdwrk/markdown-renderer-core for core parsing and rendering utilities

Full client package

Install the reusable client package when you want the packaged workspace surface:

npm install @mdwrk/mdwrkspace

Split editor and renderer packages

Install the split packages when you only need one part of the experience:

npm install @mdwrk/markdown-editor-react @mdwrk/markdown-renderer-react

The editor React package depends on the editor core package internally. The renderer React package depends on the renderer core package internally.

ESM CDN example

Load the published client directly from an ESM CDN:

<div id="mdwrkspace-root"></div>
<script type="module">
  import { mountMdWrkSpace } from "https://esm.sh/@mdwrk/mdwrkspace";

  const root = document.getElementById("mdwrkspace-root");
  mountMdWrkSpace(root);
</script>

Package selection guidance

Choose @mdwrk/mdwrkspace when you want the packaged workspace entrypoint. Choose @mdwrk/markdown-editor-react when authoring is the primary concern. Choose @mdwrk/markdown-renderer-react when rendering is the primary concern. Choose @mdwrk/markdown-renderer-core when you need lower-level parsing and HTML rendering utilities.

For package-level configuration details, see the client configuration docs. For published package discovery, use:

https://www.npmjs.com/org/mdwrk

Frequently Asked Questions

What will I learn from Standalone Modules?

MdWrk standalone modules expose the editor, renderer, extension contracts, theme tokens, and installable extension packages as reusable package surfaces.

Who should read Standalone Modules?

Read this page if you need practical MdWrk guidance for standalone modules, including the relevant workflow, product surface, and follow-up documentation paths.