meo/README.md

Markdown Editor Optimized (MEO)

An optimized markdown editor with live editing mode for VS Code.

Features

Writing & Editing

• Live/Source modes - Switch between clean writing and raw markdown in a single tab
• Toolbar formatting - Insert headings, lists, tasks, tables, code blocks, links, images, and quotes in one click
• Floating selection menu - Instantly apply bold, italic, strikethrough, inline code, or links on any text selection
• Interactive editing - Toggle tasks, open links, find/replace, render full-screen Mermaid diagrams, and LaTeX syntax
• Images - Paste images for inline rendering with automatic path resolution

Navigation & Organisation

• Contents outline sidebar - Jump to and reorder sections in long documents with ease
• Table editing - Insert and edit tables inline without writing raw syntax

Git and Agents Integration

• Change visualisations - See insertions and modifications inline
• Git blame - View commit information for any line directly in the editor
• GitHub syntax - Renders GitHub-specific markdown including collapsible details, footnotes, alerts, kbd, and emojis
• GitHub Copilot - Support of native changes review experience

Customisation & Export

• Theming - Customise syntax colors, fonts, and line height to match your style
• Syntax highlighting - Monokai-inspired theme for clear, readable markdown
• Export - Save your document as HTML or PDF
• Auto-save - Optionally save changes automatically as you type

Getting Started

1. Right-click any .md, .markdown, .mdx, or .mdc file in the Explorer → Open With Markdown Editor Optimized
2. Set as default: Cmd/Ctrl + Shift + P → Markdown Editor Optimized: Set as Default
3. Toggle between Live/Source modes: Option/Alt + Shift + M

Acknowledgements

• VS Code - Extension platform
• CodeMirror - Core editor component
• Obsidian - Inspiration

Feedback & Contributions

For any issues, suggestions, or feature requests, please open a ticket.

License

MIT License