Introduction
StackEdit is an open-source Markdown editor that runs entirely in the browser with no install required. It connects to cloud storage providers so writers and developers can draft, preview, and publish Markdown content from any device.
What StackEdit Does
- Provides a split-pane Markdown editor with real-time preview
- Syncs files bidirectionally with GitHub, GitLab, Google Drive, and Dropbox
- Renders KaTeX math expressions, Mermaid diagrams, and ABC music notation
- Supports offline editing via service workers with automatic local caching
- Publishes directly to Blogger, WordPress, and Zendesk
Architecture Overview
StackEdit is built with Vue.js and runs as a single-page application. All editing and rendering happen client-side; the optional backend handles OAuth flows for cloud storage providers. Documents are stored in the browser's IndexedDB for offline access and synced to remote providers through their respective APIs.
Self-Hosting & Configuration
- Deploy with a single Docker container or build from source with npm
- Set environment variables for OAuth client IDs to enable cloud sync
- Runs behind any reverse proxy (Nginx, Caddy) for HTTPS termination
- No database required; all state lives in the browser and cloud providers
- Customize the editor theme, keybindings, and default extensions via settings
Key Features
- Zero-install experience accessible from any modern browser
- Scroll-sync between the editor and preview panes
- Table of contents generation from headings
- Smart copy-paste that converts HTML to Markdown automatically
- Import and export to HTML, PDF, and plain Markdown formats
Comparison with Similar Tools
- Dillinger — similar browser-based editor but fewer sync targets and no math rendering
- HackMD / HedgeDoc — collaborative real-time editing; StackEdit focuses on personal cloud sync
- Typora — polished desktop app (proprietary); StackEdit is browser-based and open source
- Mark Text — open-source desktop editor with WYSIWYG; StackEdit needs no install
- Obsidian — local-first knowledge base; StackEdit is cloud-first with no local vault
FAQ
Q: Does StackEdit work offline? A: Yes. Service workers cache the app shell and IndexedDB stores documents locally. Changes sync when connectivity returns.
Q: Can I self-host StackEdit? A: Yes. Run the official Docker image or clone the repo and build with npm. You will need to register OAuth apps for each cloud provider you want to enable.
Q: Is collaborative editing supported? A: StackEdit is designed for single-user editing. For real-time collaboration, consider HedgeDoc or HackMD.
Q: What Markdown extensions does StackEdit support? A: It supports GitHub Flavored Markdown, KaTeX math, Mermaid diagrams, ABC music notation, and table of contents generation.