Osysharp.MarkdownEditor

Use it

One line in the manifest, one call on a page

The manifest names the package; the editor kit depends on the platform's Markdown capability, which stores a document as its sections, so the app declares that too. Then a page hands the editor the address of a document: which entity, which row, which member. The editor reads and writes the sections behind that address under the entity's own rules.

app MarkdownDemo {
  use Osysharp.Ui;
  use Osysharp.MarkdownEditor@1;

  // BASELINE-OUT `BL-3.2` (2026-09-22): markdown STORAGE is its own capability now. The editor kit
  // (`Osysharp.MarkdownEditor`) depends on it, and so does any entity holding a `Markdown` property.
  use Osysharp.Markdown;

  model "model/**/*.osy";
  tests "tests/**/*.test.osy";
}

    MarkdownEditor(
      ownerType: "User",
      ownerId: me.Id,
      property: "Notes",
      face: editorial,
      outline: true,

Both listings are the app that draws the screenshot below, read at build time. ownerType, ownerId and property are the address; face and outline are choices. A reader the entity's rule does not let update the row gets a read-only document.

What it gives you

An editor, and a document that stays data

See it

Over a real document

How it fits Osy#

A control declared in Osy#, over a shim it builds and pins

The package's public surface is one declaration, control MarkdownEditor in markdown.osy: the props, the slot, the events and the commands a page can use, exactly as it would use any other control. Behind it is a TypeScript shim over Milkdown and CodeMirror, bundled and checked in, with a typed ABI generated from the declaration so the shim is held to the same public control surface your own controls get. The kit pins its bundle and its maths and diagram chunks by content address in its own osyrin.lock.

It is a package rather than a platform feature so that an app which does not edit documents carries no editor. And because the owner of a package is its GitHub owner, forking it is renaming it: package Acme.Markdown lives at github.com/acme/markdown, built with osy control build and published with osy publish.

Reference

Every prop, event and command

This page says what the package is and what you can do with it. The reference says exactly how each option behaves, what the editor costs, the theme tokens it reads, and the traps that cost real time: the markdown editor kit, and osy docs ui-markdown-editor-kit at the terminal.

Source and release

Public, MIT, released on GitHub