diff --git a/www/src/pages/docs.md b/www/src/pages/docs.md index 5780f76..1d0ee2d 100644 --- a/www/src/pages/docs.md +++ b/www/src/pages/docs.md @@ -1,10 +1,10 @@ --- -title: Documentation — Writer +title: Manual — Writer description: Getting started with Writer. template: page --- -# Documentation +# Manual ## Getting Started @@ -12,7 +12,7 @@ Writer is a local-first markdown editor. On first launch you'll see an empty wor ### Adding a Workspace -Click the folder icon in the sidebar and select any directory. Writer indexes the markdown files inside it and watches for changes. +Click the folder icon in the sidebar and select any folder. Writer picks up the markdown files inside it and keeps them in sync. ```text Your Folder/ @@ -26,7 +26,7 @@ New locations automatically include a Markdown Tutorial document to help you get ### Creating Documents -Right-click in the sidebar or use the toolbar. Documents save directly to your filesystem — no intermediate database, no proprietary format. +Right-click in the sidebar or use the toolbar. Documents save as plain files on your computer — no special format, no lock-in. --- diff --git a/www/src/pages/index.md b/www/src/pages/index.md index 15ba360..4c3286e 100644 --- a/www/src/pages/index.md +++ b/www/src/pages/index.md @@ -1,6 +1,6 @@ --- title: Writer - Local-First Markdown Editor -description: A distraction-free, local-first markdown editor built with Tauri and Rust. +description: A distraction-free, local-first markdown editor. template: home --- @@ -8,7 +8,7 @@ template: home ## Markdown Editor -Built on CodeMirror 6. Fast, accessible, keyboard-driven. +Fast, accessible, keyboard-driven. - **Live Preview** - Rendered output alongside raw markdown - **Split Panes** - Editor-only, preview-only, or side-by-side @@ -39,7 +39,7 @@ Real-time feedback without getting in the way. ## File Management -The sidebar is a full file browser backed by atomic Rust operations. +The sidebar is a full file browser. Every operation is instant and reliable. - **Drag and Drop** - Reorder documents, move between locations, import `.md` files from your OS - **Context Menu** - Right-click to move, rename, or delete @@ -67,7 +67,7 @@ Turn your markdown into something you can hand to someone else. - **DOCX** - Word-compatible output for collaborators who need it. - **Plaintext** - Strip formatting and export raw text. -Markdown processing runs in Rust. Filename sanitization is handled automatically. +Filenames are cleaned up automatically so you don't have to worry about special characters. ![pdf export](/static/images/pdf-export.png) @@ -77,4 +77,4 @@ Close Writer, reopen it, and everything is where you left it. Open tabs, pane si ## Open Source -Writer is built on Tauri 2, React 19, CodeMirror 6, and Rust. The source is open to inspect, fork, and contribute to. +Writer is free and open source. The code is available to inspect, fork, and contribute to. diff --git a/www/src/templates/base.njk b/www/src/templates/base.njk index 2aed8de..b17ada1 100644 --- a/www/src/templates/base.njk +++ b/www/src/templates/base.njk @@ -21,7 +21,7 @@ diff --git a/www/src/templates/home.njk b/www/src/templates/home.njk index 4ac17a5..7dcc927 100644 --- a/www/src/templates/home.njk +++ b/www/src/templates/home.njk @@ -10,7 +10,7 @@

A local-first markdown editor. Plain files on your filesystem, real-time style feedback, and an interface that stays out of the way.

Download - Documentation + Manual
@@ -25,18 +25,18 @@
-

CodeMirror 6 Editor

-

Markdown editing with syntax highlighting, live preview, and synchronized scrolling between editor and preview panes.

+

Markdown Editor

+

Syntax highlighting, live preview, and synchronized scrolling between editor and preview panes.

Style Check

-

Aho-Corasick pattern matching in Rust. Flags filler words, redundancies, and clichés as you type. Add your own rules.

+

Flags filler words, redundancies, and clichés as you type. Add your own rules to match your style.

Folder Workspaces

-

Point Writer at any directory. Full file operations with drag-and-drop, context menus, and automatic filesystem watching.

+

Open any folder on your computer. Drag-and-drop files, right-click to manage, and changes sync automatically.

@@ -63,7 +63,7 @@

Local-First

Your documents stay on your machine as plain markdown files. No cloud sync required, no vendor lock-in. Writer uses your existing folder structure as the source of truth.

-

Built on Tauri 2 with a Rust backend handling file operations, indexing, and NLP. The frontend is React 19 and CodeMirror 6.

+

Fast and private by design. Everything runs offline and on your machine.

Workspace browser showing folder structure @@ -77,7 +77,7 @@

Writing Assistance

-

Style checking runs in real-time, highlighting potential issues without being intrusive. Pattern matching happens in Rust via Aho-Corasick for consistent performance.

+

Style checking runs in real-time, highlighting potential issues without being intrusive.

Parts-of-speech highlighting shows sentence structure at a glance. Customize patterns to enforce a house style guide.