hypnoagus / editor

A rich text editor React component for markdown

Home Page:https://mdxeditor.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MDXEditor

npm npm bundle size (scoped)

Because markdown editing can be even more delightful.

MDXEditor is an open-source React component that allows users to author markdown documents naturally. Just like in Google docs or Notion. See the live demo that has all features turned on. The component supports the core markdown syntax and certain extensions, including tables, images, code blocks, etc. It also allows users to edit JSX components with a built-in JSX editor or a custom one.

import {MDXEditor, headingsPlugin()} from '@mdxeditor/editor';

export default function App() {
  return <MDXEditor markdown={'# Hello World'} plugins={[headingsPlugin()]} />;
}

Get Started

The best place to get started using the component is the documentation.

Help and support

Should you encounter any issues, please create an issue, but check if there's something similar already open first.

License

MIT © Petyo Ivanov.

About

A rich text editor React component for markdown

https://mdxeditor.dev

License:MIT License


Languages

Language:TypeScript 92.8%Language:CSS 6.0%Language:JavaScript 1.2%Language:Shell 0.0%