Formatting Plugins

Core text formatting plugins: headings, bold, italic, strikethrough, blockquotes, and horizontal rules. These plugins handle the most common Markdown formatting needs.

Usage

All formatting plugins are included by default when using createEditor(). You can also import individual plugin factories for a custom setup.

import { createEditor } from '@synclineapi/mdx-editor';
import '@synclineapi/mdx-editor/style.css';

// All plugins are included by default
const editor = createEditor({
  container: '#editor',
  value: '# Hello World',
});

// Or pick specific plugins
import { SynclineMDXEditor, headingPlugin, boldPlugin, italicPlugin } from '@synclineapi/mdx-editor';

const editor = new SynclineMDXEditor({
  container: '#editor',
  plugins: [headingPlugin(), boldPlugin(), italicPlugin()],
});

headingPlugin()

Renders ATX-style headings (# syntax) from H1 to H6. Registers toolbar items and keyboard shortcuts Ctrl/⌘ + 1, Ctrl/⌘ + 2, Ctrl/⌘ + 3.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

boldPlugin() · italicPlugin() · strikethroughPlugin()

Inline text formatting with standard Markdown syntax. Bold uses ** or __, italic uses * or _, and strikethrough uses ~~. Each plugin registers its own toolbar button and keyboard shortcut.

**This text is bold**
__This is also bold__

*This text is italic*
_This is also italic_

***Bold and italic***

~~Strikethrough text~~

Keyboard shortcuts: Bold = Ctrl/⌘ + B, Italic = Ctrl/⌘ + I, Strikethrough = Ctrl/⌘ + Shift + X

quotePlugin()

Renders > prefixed lines as styled blockquotes. Supports nested blockquotes and inline formatting within quotes.

> This is a blockquote.
>
> Blockquotes can span multiple lines and contain **formatting**.

> Nested blockquotes:
>> This is nested one level.
>>> This is nested two levels.

Keyboard shortcut: Ctrl/⌘ + Shift + .

horizontalRulePlugin()

Inserts a horizontal rule (---) to visually separate sections of content.

Content above the rule.

---

Content below the rule.