Installation#

Add @sigx/lynx-markdown to your project.

Install the package#

pnpm add @sigx/lynx-markdown

npm install @sigx/lynx-markdown

yarn add @sigx/lynx-markdown

bun add @sigx/lynx-markdown

@sigx/richtext and @sigx/richtext-markdown come along as dependencies; their @sigx/reactivity / @sigx/runtime-core peers are the ones @sigx/lynx already requires.

The editor#

The renderer is pure JS and needs no native setup. The editor subpath (@sigx/lynx-markdown/editor) needs its two optional peers — the native rich-text field and the keyboard module:

pnpm add @sigx/lynx-richtext @sigx/lynx-keyboard
sigx prebuild

npm install @sigx/lynx-richtext @sigx/lynx-keyboard
sigx prebuild

yarn add @sigx/lynx-richtext @sigx/lynx-keyboard
sigx prebuild

bun add @sigx/lynx-richtext @sigx/lynx-keyboard
sigx prebuild

Verify#

import * as Markdown from '@sigx/lynx-markdown';

console.log(Object.keys(Markdown));