# Markdown-OS

## Docs

- [DirectoryHandler](https://mintlify.wiki/elena-cabrera/markdown-os/api/directory-handler.md): Manage multiple markdown files within a directory workspace with caching and path validation
- [HTTP Endpoints](https://mintlify.wiki/elena-cabrera/markdown-os/api/endpoints.md): REST API reference for Markdown-OS client applications
- [FileHandler](https://mintlify.wiki/elena-cabrera/markdown-os/api/file-handler.md): Safe markdown file I/O with POSIX file locks and atomic writes
- [Server API](https://mintlify.wiki/elena-cabrera/markdown-os/api/server.md): FastAPI application factory and server components for the Markdown-OS web editor
- [WebSocket API](https://mintlify.wiki/elena-cabrera/markdown-os/api/websocket.md): Real-time file change notifications via WebSocket
- [example](https://mintlify.wiki/elena-cabrera/markdown-os/commands/example.md): Generate a showcase markdown file demonstrating Markdown-OS features
- [open](https://mintlify.wiki/elena-cabrera/markdown-os/commands/open.md): Start a local web editor for markdown files or directories
- [CLI Overview](https://mintlify.wiki/elena-cabrera/markdown-os/commands/overview.md): Complete reference for the Markdown-OS command-line interface
- [Host and Port Configuration](https://mintlify.wiki/elena-cabrera/markdown-os/configuration/host-and-port.md): Configure network binding options for Markdown-OS server
- [Troubleshooting](https://mintlify.wiki/elena-cabrera/markdown-os/configuration/troubleshooting.md): Common issues and solutions for Markdown-OS
- [Auto-Save & Conflict Detection](https://mintlify.wiki/elena-cabrera/markdown-os/features/auto-save.md): Automatic content saving with debounced writes, conflict detection for external changes, and real-time WebSocket synchronization
- [Math Equations](https://mintlify.wiki/elena-cabrera/markdown-os/features/math-equations.md): Render beautiful mathematical equations using KaTeX with support for inline and display modes
- [Mermaid Diagrams](https://mintlify.wiki/elena-cabrera/markdown-os/features/mermaid-diagrams.md): Create interactive flowcharts, sequence diagrams, and more with Mermaid.js integration and pan/zoom controls
- [Syntax Highlighting](https://mintlify.wiki/elena-cabrera/markdown-os/features/syntax-highlighting.md): Beautiful code syntax highlighting with highlight.js supporting 190+ languages, line numbers, copy buttons, and theme integration
- [WYSIWYG Editing](https://mintlify.wiki/elena-cabrera/markdown-os/features/wysiwyg-editing.md): Learn how Markdown-OS's contenteditable-based WYSIWYG editor provides real-time markdown rendering with inline shortcuts and block editing
- [Directory Mode](https://mintlify.wiki/elena-cabrera/markdown-os/guides/directory-mode.md): Work with multiple markdown files in a directory workspace with file tree navigation and multi-tab editing
- [Editor Features](https://mintlify.wiki/elena-cabrera/markdown-os/guides/editor-features.md): Complete guide to the WYSIWYG editor, toolbar, keyboard shortcuts, and real-time rendering
- [Images](https://mintlify.wiki/elena-cabrera/markdown-os/guides/images.md): Upload, manage, and embed images in your markdown files with drag-and-drop and paste support
- [Single File Mode](https://mintlify.wiki/elena-cabrera/markdown-os/guides/single-file-mode.md): Learn how to use Markdown-OS to edit a single markdown file with the WYSIWYG editor
- [Themes](https://mintlify.wiki/elena-cabrera/markdown-os/guides/themes.md): Customize the editor appearance with 6 built-in themes and automatic dark mode support
- [Installation](https://mintlify.wiki/elena-cabrera/markdown-os/installation.md): Install Markdown-OS using pip or uv package manager. Supports Python 3.11+.
- [Introduction](https://mintlify.wiki/elena-cabrera/markdown-os/introduction.md): Developer-focused markdown editor that runs as a local web server with live preview, Mermaid diagrams, and auto-save.
- [Quick Start](https://mintlify.wiki/elena-cabrera/markdown-os/quickstart.md): Learn the essentials of Markdown-OS in 5 minutes. Open files, edit content, and master key features.