Moshe docs

My writing app, over a folder of Markdown files.

These pages explain Moshe the way I'd explain it to a friend sitting next to me: what each pane is for, what the buttons and keys do, and how it fits into a working day. If you're new, read "What is Moshe?" first and then "One way to use it", which is the quickest way to see how the pieces fit together. If you've used other writing apps for long texts, most of Moshe will feel familiar, and the pages on your files and on translation mode are the ones to read. The pages under "Under the hood" are the working notes for building and running Moshe, and you only need them if you're changing Moshe itself.

Getting started

• What is Moshe? — what it does, what works where, and what it works with
• One way to use it — translating, writing and keeping notes, from the desk and from the phone
• Install — the web app, the Mac and Android apps, and your own server

Writing in Moshe

• The library — Notes and the Inbox, projects, groups, the sheet list, favorites and the Trash
• Sheets and the editor — markup, comments, highlights, footnotes, links, images, glue and split
• The pen — proofreading marks with a pen, handwritten sheets, and sketches
• Goals and the dashboard — goals, the ring, statistics, history and the dashboard's views
• Keywords and filters — keywords on sheets, their colours, the Keyword Manager, and filters
• Translation mode — the original and the translation, paragraph beside paragraph
• Writing checks — Harper, Hebrew spelling and Check Text
• Writing by voice — turning it on, its keys, the one rule, a first five minutes, and every command
• Focus and the typewriter — focus mode, the line marker, highlighting and fixed scrolling
• Themes and typography — fonts, line width, Moshe's themes and your own
• Export and import — PDF, DOCX, ePub, HTML and Markdown out; Word and Markdown in
• Keyboard shortcuts — every key, in one table

Your files

• The folder, in plain words — what's on disk and why nothing is hidden
• Obsidian and Syncthing — one folder, several apps, and how edits meet

Devices and sync

• The Mac app — the window, the menu bar, and a folder on the Mac
• The Windows app — installing it, the menu bar, and a folder on the PC
• The Android app — where the library lives on the phone, sharing into Moshe
• WebDAV sync — a device without Syncthing, kept in step with the server
• Backups — hourly, daily and weekly, and getting a sheet back

Automation

• Sheets from outside — the HTTP API and the command line, for Shortcuts, bots and scripts

Running your own server

• Your own server — Docker, the password, backups, and LanguageTool

Under the hood

• The library on disk — the folder format, key by key
• The folder bridge — how the Mac, Windows and Android apps give the page a folder
• The menus — the menu bar, item for item, and what each calls in the page
• Voice — writing and editing by voice: the rule, the pieces, a native app's recognizer
• Developing Moshe — the pieces, running it, the API, the checkers and the tests
• Moshe for macOS — building and testing the Mac app
• Moshe for Windows — building and testing the Windows app
• Moshe for Android — building, signing and checking the Android app
• LanguageTool for Check Text — running LanguageTool on demand beside the server