@xiangfa/mdeditor

A Markdown editor with built-in syntax highlighting based on CodeMirror.

Install

pnpm add @xiangfa/mdeditor
# or
yarn add @xiangfa/mdeditor
# or
npm install @xiangfa/mdeditor

First editor

import {
  MagicdownEditor,
  tooltipPlugin,
  slashPlugin,
  placeholderPlugin,
} from "@xiangfa/mdeditor";

const editor = new MagicdownEditor({
  root,
  defaultValue: defaultDoc,
  extensions: [
    tooltipPlugin({ bold: "Bold" }),
    slashPlugin({ heading: { name: "Heading" } }),
    placeholderPlugin("Please enter text..."),
  ],
});

editor.create().then(({ view }) => {
  conole.log(editor.value);
  setTimeout(() => {
    editor.update("New documentation content");
  }, 3000);
});

Initialization parameters:

interface EditorConfig {
  root?: Element | DocumentFragment;
  defaultValue?: string | Text;
  languages?: LanguageDescription[];
  themes?: Extension[];
  extensions?: Extension[]; // 手动传入插件/扩展
  keymaps?: KeyBinding[];
  i18n?: I18n; // 不再自动注入插件，请手动传给插件
}