Introduction
Overview
inksane is a modular, extensible Markdown editor for the web, built on CodeMirror 6.
inksane is a headless, extensible Markdown editor for the web. It renders Markdown in place while you type and keeps the document as Markdown the whole time, so the same content can go to a file, a database, or an API without a conversion step.
The editor is built on CodeMirror 6 and is headless by design: it does not ship a visual theme, so the look of your editor is up to you.
Early development
inksane is under active development and has not reached a first release yet. The API can change between releases.
Why inksane
- Markdown first — the document is Markdown. Read it with
getMarkdown()and replace it withsetMarkdown(). - Headless — no bundled theme. Style the editor to match the rest of your app.
- Extensible — every feature, including bold, lists, and links, is an extension built from the same public API you can use.
- Typed commands — commands return a boolean, chain, and are typed through module augmentation.
What ships today
| Package | What it adds |
|---|---|
@inksane/core | The editor, BaseKit, feature extensions, and commands |
@inksane/react | A provider, a component, and hooks for React |
@inksane/extension-collaboration | Yjs collaboration and remote cursors |