Files
llm-in-text/milkdown-docs/guide/prosemirror-api.md
ydy0615 d9ab341223 Add documentation for using Milkdown with various frameworks
- Created a new document for using components in Milkdown.
- Added a guide for using plugins in Milkdown, including toggling plugins programmatically and listing official plugins.
- Introduced a recipe for integrating Milkdown with Angular, including installation steps and component creation.
- Added a recipe for using Milkdown with Next.js, detailing installation and component setup.
- Created a guide for integrating Milkdown with NuxtJS, including installation and component creation.
- Added a comprehensive guide for using Milkdown with React, covering both Crepe and core Milkdown usage.
- Introduced a recipe for SolidJS integration with Milkdown, including installation and component creation.
- Added a guide for using Milkdown with Svelte, detailing installation and component setup.
- Created a comprehensive guide for integrating Milkdown with Vue, covering both Crepe and core Milkdown usage.
- Added a recipe for using Milkdown with Vue2, including installation and component creation.
2026-01-17 14:18:08 +08:00

1.3 KiB

Prosemirror API

Milkdown is built on top of prosemirror. Which means you can use the entire prosemirror API in Milkdown. To access the prosemirror API, you can use the @milkdown/prose package. It re-exports all of the prosemirror API. Using this package you can make sure that you are using the same version of prosemirror as Milkdown.

Installation

To access a certain API in the prosemirror-x package, you need to import them from @milkdown/kit/prose/x.

For example:

// Originally in prosemirror-state
import { EditorState } from "@milkdown/kit/prose/state";
// Originally in prosemirror-view
import { EditorView } from "@milkdown/kit/prose/view";

List of packages

The following is a list of all the re-exported prosemirror API.

  • @milkdown/kit/prose/changeset
  • @milkdown/kit/prose/commands
  • @milkdown/kit/prose/dropcursor
  • @milkdown/kit/prose/gapcursor
  • @milkdown/kit/prose/history
  • @milkdown/kit/prose/inputrules
  • @milkdown/kit/prose/keymap
  • @milkdown/kit/prose/model
  • @milkdown/kit/prose/schema-list
  • @milkdown/kit/prose/state
  • @milkdown/kit/prose/transform
  • @milkdown/kit/prose/view
  • @milkdown/kit/prose/tables

You can find the documentation of the prosemirror API here.