This React component provides a flexible Markdown editor with both WYSIWYG and markup modes, targeting developers building content creation interfaces. It offers a dual-editing experience, allowing users to switch between visual and code-based Markdown editing, enhancing productivity and control.

How It Works

The editor leverages ProseMirror and CodeMirror engines to provide a robust editing experience. ProseMirror handles the rich text (WYSIWYG) aspects, while CodeMirror manages the markup view. This dual-engine approach allows for seamless switching between modes and extensibility for custom syntax or features.

Quick Start & Requirements

• Install: npm install @gravity-ui/markdown-editor
• Dependencies: react, react-dom, @gravity-ui/uikit, @gravity-ui/components, @diplodoc/transform, and others (check peerDependencies).
• Setup: Requires a React project. Styling and theming depend on @gravity-ui/uikit documentation.
• More Info: How to connect, Preview, Extensions

Highlighted Details

• Supports basic Markdown and YFM syntax.
• Extensible via ProseMirror and CodeMirror engines.
• Offers both WYSIWYG and Markup editing modes.
• Includes documentation for HTML, Latex, Mermaid, GPT, and text binding extensions.

Maintenance & Community

• Development is managed via npm start for Storybook.
• Internationalization can be configured using configure({ lang: 'ru' }).
• Contribution guidelines are available.

Licensing & Compatibility

• License: Not explicitly stated in the README.
• Compatibility: Designed for React projects. Requires other @gravity-ui packages.

Limitations & Caveats

The specific license is not detailed, which may impact commercial use. The project relies heavily on the @gravity-ui ecosystem, requiring integration with its UI components and theming.