English | 中文

Markdown editor for react, developed in jsx and typescript.

• Documentation and demo：Go

• The same series editor for vue3：md-editor-v3

• Toolbar, screenfull or screenfull in web pages and so on.
• Themes, Built-in default and dark themes.
• Shortcut key for editor.
• Beautify your content by prettier(only for markdown content, not the code and other text).
• Multi-language, build-in Chinese and English(default: Chinese).
• Upload picture, paste or clip the picture and upload it.
• Render article directly(no editor, no event listener, only preview content).
• Theme of preview, default, vuepress, github, cyanosis, mk-cute, smart-blue styles(not identical). It can be customized also(Refer to example page).
• mermaid(>=1.3.0), katex mathematical formula（>=1.4.0）.
• Customize the toolbar as you like.
• On-demand Import(>=4.0.0).

Default theme	Dark theme	Preview only

Inputing prompt and mark, emoji extensions

npm i md-editor-rt

Use existing extension of language and theme, such as Japanese

npm i @vavt/cm-extension

Use existing components of toolbar, such as exporting content as PDF

npm i @vavt/v3-extension

For more ways to use or contribute, please refer to: md-editor-extension

Starting from 4.0.0, internal components can be imported on-demand.

import React, { useState } from 'react';
import { MdEditor } from 'md-editor-rt';
import 'md-editor-rt/lib/style.css';

export default () => {
  const [text, setText] = useState('# Hello Editor');
  return <MdEditor modelValue={text} onChange={setText} />;
};

import React, { useState } from 'react';
import { MdPreview, MdCatalog } from 'md-editor-rt';
import 'md-editor-rt/lib/preview.css';

const scrollElement = document.documentElement;

export default () => {
  const [text] = useState('# Hello Editor');
  const [id] = useState('preview-only');

  return (
    <>
      <MdPreview id={id} modelValue={text} />
      <MdCatalog editorId={id} scrollElement={scrollElement} />
    </>
  );
};

When using server-side rendering, scrollElement should be of string type, eg: html, body, #id, .class.

For more usage, please visit the document.

The release workflow in .github/workflows/latest.yml reads commit messages to build CHANGELOG.md.

• Format: <type>(<scope>)!: <summary>
• Recommended types:
  • feat: goes to Features
  • refactor: goes to Refactors
  • fix: goes to Fixed Bugs
  • other types: goes to Others
• Subject should describe the user-visible change/problem being solved, not only the mechanical action (e.g. avoid only writing bump xxx).
• Prefer adding commit body (git cz long description) to explain motivation and impact, especially for dependency upgrades.
• Do not use pure version subjects like 6.3.2 or v6.3.2-beta.1 (ignored by release parser).
• docs(changelog): ... is reserved for the bot-generated changelog commit.
• If you add #123 in subject/body, release automation will notify and close that issue after publishing. Only reference issue numbers that are truly resolved.

Examples:

git commit -m "feat(editor): support drag-sort toolbar items"
git commit -m "fix(preview): sync anchor when heading id contains emoji #1234"
git commit -m "fix(deps): bump @vavt/markdown-theme to fix mermaid overflow"
git commit -m "refactor(build): simplify dts rollup pipeline"