Skip to content

Repository files navigation

SnapDock

A calm, modern Markdown editor for Windows and Linux

Website · Documentation · Downloads · Report a bug

Status Platforms GitHub downloads License: MIT

SnapDock gives you a focused place to write, organise, and preview Markdown without turning your editor into an IDE. It is local-first, offline-friendly, and designed to stay out of your way.

SnapDock in the light theme on Ubuntu SnapDock in the dark theme on Windows 11

Features

  • Workspace-based file management with a file tree and workspace-scoped recent files
  • Multi-tab editing with drag-and-drop tab reordering and unsaved-change protection
  • Flexible previews with full-page and resizable split views
  • Rich Markdown rendering including syntax highlighting, footnotes, task lists, emoji, anchors, marks, subscript, and superscript
  • Find in document with keyboard navigation between matches
  • Writing metrics for words and characters
  • PDF export directly from the rendered preview
  • Built-in spellcheck with correction suggestions from the native context menu
  • Five included themes: Light, Dark, Solarized, Arctic Dark, and Forest
  • Local-first workflow that keeps your Markdown files on your computer

Installation

Choose your preferred store for straightforward installation and updates.

Microsoft Store

Download from the Microsoft Store

Snap Store

Get it from the Snap Store

sudo snap install markdown-workspace

GitHub Releases

Installers and portable builds are also available from GitHub Releases.

On Linux, AppImage builds may require FUSE. On Ubuntu and Debian, install it with sudo apt install libfuse2. Snap and .deb installations do not require this AppImage-specific step.

System requirements

  • Windows 10 or later, or a modern Linux distribution
  • 2 GHz processor
  • 2 GB RAM
  • 2 GB available disk space

macOS is not currently supported.

Build from source

You will need a current Node.js release and npm.

git clone https://github.com/ZFordDev/SnapDock.git
cd SnapDock
npm install
npm run build:dev

Project status and roadmap

SnapDock is stable, actively maintained, and open to contributions. Development priorities evolve with user feedback, so the live GitHub trackers are the source of truth:

Known limitations

  • Live preview is not yet available; standard and split previews update while you work.
  • Electron and Chromium can behave differently across Linux display servers and desktop environments. Please report reproducible issues with your distribution, desktop environment, and display server.

Support and contributing

Bug reports, feature ideas, documentation improvements, and code contributions are welcome. Read CONTRIBUTING.md before submitting a change, and use the issue tracker for bugs and suggestions.

Security vulnerabilities should be reported using the process in SECURITY.md, not through a public issue.

If SnapDock is useful to you, starring the repository or sharing the project also helps.

License

SnapDock is free and open-source software released under the MIT License.

About

SnapDock is part of the SnapDock ecosystem, a collection of focused tools for writing, planning, and creating. It is built and maintained by ZFordDev.

About

The lightweight, fast Markdown editor. Built on Electron

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages