Help

Everything you need to start writing in Lumens.

Getting started

Open app.lumens.page. You write Markdown on one side and a typeset preview appears on the other. There is no account and nothing to set up.

Lumens also renders math (KaTeX), diagrams (Mermaid), callouts, task lists, footnotes and titled code blocks. Slides are split wherever a line contains only ---.

Keyboard shortcuts

Mod is Ctrl on Windows and Linux, Cmd on macOS. Press ? outside a text field for the full, searchable list inside the app.

ShortcutAction
Mod+P or Mod+Shift+PCommand palette
Mod+KCommand palette (focus outside the editor); insert link (in the editor)
/Command palette (outside any text field); slash menu of blocks (on an empty line in the editor)
?Keyboard shortcut sheet (outside any text field)
Mod+SSave as .md
Mod+OOpen a file
Mod+Shift+ODocuments drawer
Mod+.Zen mode
Mod+Shift+EnterPresent as slides
Mod+B / Mod+IBold / italic (in the editor)
Tab / Shift+TabIndent / outdent (in the editor; Esc then Tab leaves it)
Left / Right, PageUp / PageDown, Space, Home / EndTurn pages (Book mode)
Left / Right / Space / F / EscPrevious or next slide, fullscreen, exit (while presenting)

Files and storage

Everything stays on your device. Documents, settings and version history are kept in your browser storage (IndexedDB, plus a few settings in localStorage), and documents are saved automatically as you type. Nothing is uploaded. When you choose to view a Markdown link (palette: Open a Markdown link), Lumens fetches that file directly from GitHub. Your documents are not sent anywhere, and GitHub may log the request like any web visit.

Back up what matters. Clearing site data, using a private window or removing the browser can erase your documents, and so can losing the device. Export the documents you care about as .md files, or save them to disk with Mod+S.

Images

Add an image with the toolbar Image button, the / slash menu, by pasting from the clipboard, or by dragging a file into the editor. The Image button also has a link option for pictures that live on a website.

Installing the app

Lumens is an installable web app (PWA). In Chrome or Edge, use the install icon in the address bar or the Install option in the browser menu. In Safari on iPhone or iPad, choose Share, then Add to Home Screen. Installed, it opens in its own window like any other app.

Offline use

The libraries the editor needs are bundled with the app. After your first visit the app is cached on your device and works without a connection. When a new version is available, a message offers a Reload, so your typing is never interrupted.

Export

Use the Export menu in the header, or search for "Export" in the command palette.

Privacy in brief

Your writing stays in your browser and is not sent to us. Rendered Markdown is sanitized before it is shown. Read the full Privacy policy.

Anonymous usage counts. Lumens sends simple counts of events such as opening the app or using an export, with no document content and no identifier. To turn them off, switch off Share anonymous usage counts in Settings or use the command palette. They are also off automatically if your browser sends Do Not Track or Global Privacy Control. Nothing is sent while you are offline.

Contact

Questions, bug reports and feedback: [email protected]
Security reports: [email protected]

Open the editor