MDX Editor

Sleeve's MDX editor combines the simplicity of Markdown with the power of React components, giving you a professional writing experience with live preview and AI assistance.

Editor Features

Rich Text Editing

The editor provides an intuitive interface for creating and formatting content:

Live Preview

See your changes in real-time as you type:

AI Writing Assistant

The AI writing assistant helps you create better documentation faster by leveraging your existing knowledge base.

Activating the Assistant

What the Assistant Can Do

Context-Aware Suggestions

The AI assistant is uniquely powerful because it has access to all your documentation:

Example Use Cases:

Prompt: "Create documentation for the user authentication endpoint"

Assistant searches existing API docs, finds similar patterns, 
and generates consistent documentation following your style.

Prompt: "Make this section clearer"

Assistant analyzes the selected text and rewrites it for 
better clarity while maintaining your technical accuracy.

Prompt: "What have we written about database migrations?"

Assistant searches your docs and provides a summary with 
links to relevant pages.

Assistant Interface

The assistant appears as a floating panel next to your cursor:

MDX Component Library

Sleeve supports a rich set of MDX components to make your documentation interactive and visually appealing:

Code Blocks

Create beautiful, syntax-highlighted code blocks with titles:

const greet = (name) => {
  console.log(`Hello, ${name}!`);
};

greet('World');

def greet(name):
    print(f"Hello, {name}!")

greet("World")

function greet(name: string): void {
  console.log(`Hello, ${name}!`);
}

greet('World');

Best Practices

Keyboard Shortcuts

Master these shortcuts to write more efficiently: