Markdown Editor Pro

A powerful, feature-rich markdown editor built with React, TypeScript, and Tailwind CSS. This editor provides a seamless writing experience with live preview, math equation support, and beautiful GitHub-inspired styling.

🔗 Live Demo

✨ Features

• 📝 IDE-style Split View - CodeMirror 6 editor with live preview side by side, draggable divider, bidirectional scroll sync
• 🗂️ Multiple Documents - Tabbed editing, autosaved to your browser — nothing ever leaves your machine
• 🧭 Outline Pane - Heading tree, click to jump anywhere in the document
• 💾 Real File Editing - Open and save local .md files natively (Ctrl+S) via the File System Access API
• 🧮 Math Support - Full LaTeX equation support via KaTeX
• 🧜 Mermaid Diagrams - Flowcharts, sequence and class diagrams rendered in-browser (lazy-loaded)
• 📋 GitHub Flavored Markdown - Tables, task lists, strikethrough, and more
• 🛠️ Formatting Toolbar - Plus keyboard shortcuts (Ctrl+B/I/K, Ctrl+F search)
• 🖼️ Image Paste - Paste or drag-drop images straight into the editor as self-contained base64
• 📤 Export - Standalone HTML file or print-to-PDF
• ✨ AI Assist (BYOK) - Improve, proofread, summarize or continue writing with your own API key (OpenRouter, OpenAI, or local Ollama)
• 🌙 Dark/Light Theme - Class-based theming with a toggle, follows your system by default
• ✍️ Focus & Typewriter Modes - Distraction-free writing
• 📴 Offline PWA - Installable as an app; works with no internet
• 📊 Real-time Stats - Line/column, character, word, and line count

🚀 Quick Start

Prerequisites

• Node.js 18+
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/seehiong/md-editor-pro.git
cd markdown-editor-pro

# Install dependencies
npm install

# Start development server
npm run dev

# Open http://localhost:5173 in your browser

Integration into Your React App

import { MarkdownEditor } from './components/MarkdownEditor';

function App() {
  return (
    <div className="container mx-auto p-4">
      <MarkdownEditor />
    </div>
  );
}

📝 Markdown Features

Basic Formatting

• Headers - # H1 through ###### H6
• Emphasis - *italic*, **bold**, ~~strikethrough~~
• Links - [text](https://github.com/seehiong/md-editor-pro/blob/main/url) and reference-style links
• Images - ![alt text](https://raw.githubusercontent.com/seehiong/md-editor-pro/main/image-url) with automatic sizing

Advanced Features

• Code Blocks - Syntax highlighting with fenced code blocks
• Tables - Full table support with column alignment
• Lists - Bulleted, numbered, and interactive task lists
• Blockquotes - > quoted text with nested support
• Math Equations - LaTeX support for inline and block equations
• Horizontal Rules - --- or ***

Math Equation Examples

Inline math: $E = mc^2$ renders as $E = mc^2$

Block math:

$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

🎨 Theming

The editor automatically adapts to your application's theme system:

// Light mode (default)
<MarkdownEditor />

// Dark mode - add 'dark' class to any parent element
<div className="dark">
  <MarkdownEditor />
</div>

Theme Features

• Clean, GitHub-inspired light theme
• Beautiful dark mode with proper contrast ratios
• Smooth transitions between themes
• Respects system preferences

🛠️ Tech Stack

• React 18 - Modern UI framework
• TypeScript - Type safety and better DX
• Tailwind CSS - Utility-first styling
• Vite - Fast build tool and dev server
• react-markdown - Markdown parsing and rendering
• KaTeX - High-quality math typesetting
• Lucide React - Beautiful, consistent icons

📦 Project Structure

src/
├── components/
│   ├── MarkdownEditor.tsx     # Main editor component
│   ├── MarkdownGuide.tsx      # Interactive help guide
│   ├── MarkdownRenderers.tsx  # Custom code block renderers
│   └── MermaidDiagram.tsx     # Mermaid diagram support
├── App.tsx                    # Root component
├── main.tsx                   # Application entry point
└── index.css                  # Global styles and Tailwind imports

⚙️ Configuration

Customizing Features

// Disable specific features
<MarkdownEditor 
  showStats={false}
  allowFileOperations={false}
  enableMath={false}
/>

Styling Customization

The editor uses Tailwind CSS classes and can be customized by:

• Modifying the component's className props
• Overriding CSS custom properties
• Extending the Tailwind configuration

Adding Plugins

// Add custom remark/rehype plugins
import remarkGfm from 'remark-gfm';
import rehypeHighlight from 'rehype-highlight';

// Configure in MarkdownEditor component

🚀 Usage Examples

Basic Implementation

import { MarkdownEditor } from './components/MarkdownEditor';

export default function MyApp() {
  return (
    <div className="min-h-screen bg-gray-50 dark:bg-gray-900">
      <div className="container mx-auto py-8">
        <h1 className="text-3xl font-bold mb-6">My Markdown Editor</h1>
        <MarkdownEditor />
      </div>
    </div>
  );
}

With Custom Styling

<div className="max-w-4xl mx-auto">
  <MarkdownEditor className="border border-gray-200 rounded-lg shadow-lg" />
</div>

📱 Responsive Behavior

• Desktop - Full feature set with side-by-side edit/preview
• Tablet - Adaptive layout with toggle between edit/preview
• Mobile - Optimized touch interface with swipe gestures

🤝 Contributing

We welcome contributions! Here's how to get started:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Add amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Open a Pull Request

Development Guidelines

• Follow TypeScript best practices
• Maintain existing code style
• Add tests for new features
• Update documentation as needed

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• GitHub for design inspiration and markdown standards
• React Markdown community for excellent tooling
• KaTeX for beautiful mathematical typesetting
• Tailwind CSS for utility-first styling philosophy
• Lucide for the beautiful icon set

📧 Support

If you have questions or need help integrating this editor:

• Open an issue for bugs or feature requests
• Check out the live demo for examples
• Review the built-in help guide within the editor

Made with ❤️ for the React community

Star ⭐ this repo if you find it useful!