Markdown#

Streaming markdown rendered to native views and a block-tree editor on native fields — the Lynx host of @sigx/richtext.

v0.35.0 iOS · Android MIT

Installation#

pnpm add @sigx/lynx-markdown

npm install @sigx/lynx-markdown

yarn add @sigx/lynx-markdown

bun add @sigx/lynx-markdown

About#

@sigx/lynx-markdown renders and edits @sigx/richtext trees natively. The parser, the streaming controller, the render engine and the editor core are shared with the web through @sigx/richtext and @sigx/richtext-markdown (regular dependencies); this package maps them onto Lynx views and native rich-text fields. MarkdownView renders a growing source without re-rendering finished blocks, and MarkdownEditor (from @sigx/lynx-markdown/editor) edits the same mdast tree block by block. It is versioned in lockstep with the rest of the Lynx module family.

Next steps#

Continue with Installation for project setup, or jump to the API reference.