Getting Started

Start with the MdWrk setup paths that get the workspace running in a browser, as an installable PWA, from a local checkout, or through standalone packages.

1. Choose the setup path that matches how you want to use MdWrk.
2. Open the matching Getting Started article.
3. Follow the article into configuration, local setup, PWA installation, or package use.

Choose a setup path

• Client Installation: Use the browser route for immediate access, the PWA route for an installable shell, local setup for development control, or standalone modules for package-level adoption.
• Browser Use: The browser path runs the MdWrk client directly in a supported browser, keeps documents local by default, and remains usable offline after app assets are cached.
• PWA Installation: The Progressive Web App path keeps the MdWrk client in the web platform, but lets supported browsers install it as a dedicated app window.
• Local Setup: This path is for maintainers, internal adopters, and self-hosting operators who want more control than the browser or PWA flows provide.
• Standalone Modules: MdWrk standalone modules expose the editor, renderer, extension contracts, theme tokens, and installable extension packages as reusable package surfaces.
• Client Configuration: Theme Selection Open Settings -> Theme to switch between built-in theme families. Themes are contract-backed and flow through the editor, preview, export, and extension theme APIs.

What to read next

After setup, continue into product docs for local-first workflow, editor and preview behavior, extension host boundaries, and theme packages.