Docs · Typmin

How to use Typmin.

A quick tour of every surface, plus what we keep on your device instead of the server.

01 · Account

Make an account.

Go to /signup, pick a username, pick a password (min 8 characters). You land on the Home dashboard.

No email, no verification. Your draft data is private to your account; keystroke counts are aggregated into the leaderboard.

02 · Home

Your dashboard.

Visit /. You'll see:

  • A live clock with timezone + optional countdown.
  • Continue writing → pill that opens your latest doc.
  • Today and All-time keystroke totals.
  • The currently growing seed, plus recent harvests.
  • Today's leaderboard and the shared Playground.
03 · Write

The editor.

/write is an Obsidian-style page on a desk. The top TabsBar holds recent documents; switching tabs preserves your last scroll + cursor position per document.

A Local mode toggle in the sidebar lets you open a real folder on disk and edit multiple .md files in tabs — nothing is uploaded (see §06). Requires Chrome, Edge, or Arc.

The status bar has a Page ↔ Wide toggle: Wide strips borders + max-width so your text fills the editor edge-to-edge. Choice is remembered per-browser.

When a seed hatches, a planter modal pops instantly — one click to Stay with [country] or pick a new one.

04 · Passport

Collect plant-spirits.

/passport shows your collection indexed by country. There are 60 animals across 12 countries, each with time-of-day and roll variants.

  • Plant on a country card to start a seed.
  • At ~1,000 keystrokes it hatches into a grown typmin.
  • 放生 (two-click confirm) frees an owned animal.
  • Changing seeds mid-growth asks you to confirm — progress is lost.
05 · Journal & Feedback

Share and report.

/journal is a small community feed: daily reports, good news, and usage tips. Everyone logged in can post, browse, and upvote.

/feedback is the same shape but for product reports — suggestions, bugs, general thoughts. Posts move from Open → In progress → Resolved.

06 · Local storage

What we keep on your device.

Typmin's local storage option is a deliberate pattern: anything that is preference work lives in your browser, never on the server. Clearing browser storage resets it; logging out does not.

typmin:editor-widthPage ↔ Wide toggle in /write.
typmin-timewidgetTimezone + countdown on Home.
typmin_seen_versionLast "what's new" you dismissed.
app-prefsTheme preset, dark/light mode, font toggle, accent hex.

To wipe all of it: DevTools → Application → Local Storage → delete the typmin* and app-prefs keys. Your account, saved documents, and collection on the server are untouched.

Local mode is the privacy affordance: open /write, enable Local mode in the sidebar, and pick a folder. Files are read and written directly on your disk — nothing hits /api/documents. Keystroke counts still batch to the server as an anonymous delta. Requires Chrome, Edge, or Arc (File System Access API).

The folder handle for Local mode is stored in IndexedDB under typmin:local-vault-handle — not syncable, not uploaded.

07 · Settings

Make it yours.

/account/settings holds appearance and privacy controls.

  • Dark / Light toggle.
  • 29 theme presets — Gruvbox, Everforest, Nord, Solarized, Tokyo Night, Catppuccin (all four), Rosé Pine, Dracula, One Dark, Kanagawa, GitHub, Warm Cream/Cocoa, High Contrast, and more. Live search filters the list.
  • Custom hex accent — override the palette's accent.
  • Font toggle — sans vs serif.
  • Privacy — delete any saved document.
08 · Privacy

We count keystrokes, not content.

The whole reason Typmin exists:

  1. The editor fires a keydown → lib/keystroke-counter.js increments an integer.
  2. The key value is discarded immediately — our code never reads it.
  3. Every 10 seconds the counter delta batches to the server with a session ID. No keys, no text fragments.
  4. Drafts you explicitly save live in our DB, private to your account.
  5. Local files never leave your disk — they aren't uploaded to our servers.

Full write-up with source references: /privacy.

Create an account →Open the editorRead the privacy contract