Browse documentation

Using editmd

Files, folders and recovery

Keep related writing together and understand where your changes live.

On this page
A SIMPLE DOCUMENT WORKSPACE
  1. Project folder

    A place you choose on your Mac.

  2. README.md + notes.md

    Plain text documents, open in tabs.

  3. images/

    Keep attachments beside the writing.

One file or a whole folder

Use File → Open File… for a single document. Use File → Open Folder… for a workspace: a folder of related Markdown and attachments. The sidebar lets you navigate the folder while tabs keep multiple documents within reach.

A useful starting arrangement is a project folder with a README.md, a notes.md and an images folder. You choose the names and locations; editmd does not require a particular folder structure.

Move around quickly

  • Quick Open (⌘P): find files in the current workspace, recent files and recent workspaces.
  • Search Workspace (⌘⇧F): search across the folder’s documents.
  • Outline (⌘⇧E): navigate the current document by its headings.
  • Tabs: switch between open documents. A changed document needs saving.

Save before moving on

Use ⌘S to write your changes to the file. Renaming or moving files changes their locations, so check links and image references afterwards. Delete in the sidebar removes a file or folder from disk permanently; it does not go to the Trash. editmd asks first and warns if open documents inside it have unsaved changes.

If you use a cloud-synced folder, wait for that service to finish syncing before opening the same document on another device. editmd is not a real-time collaboration or sync service.

When another app changes the file

editmd watches open files and workspaces for external changes. If the document has unsaved edits, an external change becomes a conflict: a banner offers Reload from disk or Keep my version. Compare the versions before choosing; save an extra copy of important text if you are unsure.

Do not repeatedly save over a conflict without checking it. Two editors or a sync service can both be changing the same file.

Returning after an interruption

Session restore can reopen files, tabs, the workspace and view state. Bounded recovery can restore unsaved edits after an interruption. Read any recovery notice: some files may no longer be accessible, and storage limits can prevent recovery of every buffer.

After recovery, inspect the text and save the version you want. Keep independent backups for important work; recovery is not version history or a backup system.

Agent-readable/docs/workspace.md
Save .md