https://github.com/mdx-editor/editor

A rich text editor React component for markdown
https://github.com/mdx-editor/editor

editor lexical markdown markdown-editor mdx react reactjs rich-text-editor

Last synced: 5 days ago
JSON representation

A rich text editor React component for markdown

• Host: GitHub
• URL: https://github.com/mdx-editor/editor
• Owner: mdx-editor
• License: mit
• Created: 2023-01-19T09:45:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T05:09:22.000Z (about 2 months ago)
• Last Synced: 2025-01-14T06:02:01.996Z (12 days ago)
• Topics: editor, lexical, markdown, markdown-editor, mdx, react, reactjs, rich-text-editor
• Language: TypeScript
• Homepage: https://mdxeditor.dev
• Size: 2.28 MB
• Stars: 2,205
• Watchers: 11
• Forks: 170
• Open Issues: 64
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-github-star - editor - editor | 561 | (TypeScript)

README

        
# MDXEditor

![npm](https://img.shields.io/npm/v/@mdxeditor/editor)

![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@mdxeditor/editor)

> 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](https://mdxeditor.dev/editor/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.

```jsx

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

import '@mdxeditor/editor/style.css';

export default function App() {

  return ;

}

```

## Get Started

The best place to get started using the component is the [documentation](https://mdxeditor.dev/editor/docs/getting-started).

## Help and support

If you find a bug, check if something similar is not reported already in the [issues](https://github.com/mdx-editor/editor/issues). If not, [create a new issue](https://github.com/mdx-editor/editor/issues/new?assignees=&labels=bug&projects=&template=1.bug.md&title=%5BBUG%5D).

If you're integrating the component in your commercial project and need dedicated assistance with your issues in exchange of sponsorship, [contact me over email](mailto:[email protected]).

If you want to discuss ideas [join the Discord server](https://discord.gg/4q7U2Hc) or start a discussion in the [Discussions](https://github.com/mdx-editor/editor/discussions) section.

## License

MIT © Petyo Ivanov.