SnapDock — Getting Started

← Back to SnapDock Index

Introduction

This guide covers the basics of installing SnapDock, launching it for the first time, working with files, and understanding its interface.

System Requirements

SnapDock is lightweight and runs on virtually any modern system.

Operating System

• Windows 10 or later
• Linux (Ubuntu, Debian, Fedora, Arch, Mint, Pop!_OS, etc.)
• WSL is supported, but the in‑app updater is disabled
• macOS support is not currently available

Hardware

• CPU: 1 core minimum (2 cores recommended)
• Memory: 512 MB minimum (1 GB recommended)
• Disk Space: 750 MB minimum (1 GB recommended)

Performance

SnapDock typically uses ~180 MB RAM and under 1% CPU during normal editing, making it suitable even for low‑power laptops, VMs, and older hardware.

If anyone tests SnapDock on a Raspberry Pi, we’d love to hear how it performs.
~ ZFordDev

---

Installation

Prerequisites

No special setup is required. Simply download the installer for your platform.

Steps

1. Download the installer.
2. Run the installer.
3. Start using SnapDock immediately.

---

First Launch

When you open SnapDock for the first time, you can:

• Begin typing directly into the workspace.
• Click New to create a fresh tab.

Each document remains open until you explicitly close it. SnapDock is designed to be simple and fast, ready as soon as it opens.

---

Opening & Saving Files

SnapDock supports both single‑file editing and full folder workspaces.

Opening Files

You can open content in two ways:

• Open File — choose a single .md file
• Open Folder — load an entire directory into the file tree

When opening a folder:

• The file tree appears on the left
• The workspace header updates to reflect the folder name
• You can browse and open files instantly

Recent Files

Above the file tree, you’ll find a Recent Files panel.
If you close a tab, you can quickly reopen it from here without navigating your filesystem again.

Saving Files

SnapDock uses a simple save system:

• Red dot — unsaved changes
• Yellow dot — saved once, but new edits exist
• Green dot — fully saved and safe to close

There is currently no Save All button; each tab is saved individually.

---

Understanding the Interface

This section covers:

• The editor
• The preview pane
• The file tree
• The tab system
• The workspace header
• Theme selector
• Status indicators

(Additional details will be added here as they become available.)

---

Why “SnapDock”?

The name SnapDock comes from the very first feature that defined the app: the ability to snap a document directly into the editor, creating a clean two‑pane writing environment. Originally called SnapDoc, the idea was simple — a document that “snaps” into place.

When the file tree was introduced, the layout evolved into a true dock: a sidebar for navigation and the main workspace. The name naturally shifted to SnapDock while maintaining its original spirit.

Ironically, the snapping feature that inspired the name was later removed in the 2.x LTS series. As the app grew to support tabs and more stable workspace logic, the original snap‑to‑editor behavior became incompatible with the new architecture. It may return in a future version, but the name remains as a nod to SnapDock’s roots — a lightweight, focused writing environment.

---