Files
llm-in-text/milkdown-docs/plugin/using-components.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.6 KiB

Using Components

Components are features work out of the box that built on top of plugins. Each component is a separate module. You can use them by importing them from @milkdown/kit/component/*. All components can be used just like plugins.

import { imageBlock } from "@milkdown/kit/component/image-block";
import { Editor } from "@milkdown/kit/core";

Editor.make().use(/* some other plugins */).use(imageBlock).create();

Components are designed to be headless, which means they are not opinionated about the UI. You can use them to build your own editor UI. Components are built by web components and can be used in any framework.


List of Components

Name Description
Code Block Render code by Codemirror
Image Block Render an image as a block
Image Inline Provide placeholder and uploader features for inline image
Link Tooltip Provide edit and preview feature for link
List Item Renderers bullet, ordered and task list by custom renderer
Table Block Render table and provides table editing features