Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.95 KB

File metadata and controls

41 lines (31 loc) · 1.95 KB

@mdwrk/example-editor-basic

Workspace example app

Hits Downloads Node License: Apache-2.0

This example app demonstrates how to wire the public MdWrk editor and renderer packages together in a consumer-facing project shape.

Why

It is the quickest way to confirm that source editing, previewing, and public package boundaries work outside the main client application.

What

  • A small app that consumes the editor and renderer packages through their published entrypoints.
  • A reference for install, build, and local debugging flow.
  • Proof that package consumers do not need private client internals to build a usable editing surface.

Installation

Node.js 20.x through 22.x, matching the workspace engine contract in the root package manifest.

npm install
npm run build -w @mdwrk/example-editor-basic

Usage

Build the example from the workspace root, then inspect how the public package interfaces are imported.

npm run typecheck -w @mdwrk/example-editor-basic
npm run build -w @mdwrk/example-editor-basic

Related