Skip to content

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

License

Notifications You must be signed in to change notification settings

u14app/markdown-editor

Repository files navigation

@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 { MarkdownEditor } from "@xiangfa/mdeditor";

const editor = new MarkdownEditor({
  root,
  defaultValue: defaultDoc,
});

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[];
  placeholder?: string;
}

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published