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.
- Pick a view: Split Studio, Focus Write, Live Gallery or Book.
- Type / on an empty line in the editor for a menu of headings, callouts and other blocks.
- Select text to get a formatting toolbar.
- Lists and quotes continue when you press Enter.
- Press Ctrl+P (Cmd+P on macOS) for the command palette, which reaches every action, theme and setting.
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.
| Shortcut | Action |
|---|---|
| Mod+P or Mod+Shift+P | Command palette |
| Mod+K | Command 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+S | Save as .md |
| Mod+O | Open a file |
| Mod+Shift+O | Documents drawer |
| Mod+. | Zen mode |
| Mod+Shift+Enter | Present as slides |
| Mod+B / Mod+I | Bold / italic (in the editor) |
| Tab / Shift+Tab | Indent / outdent (in the editor; Esc then Tab leaves it) |
| Left / Right, PageUp / PageDown, Space, Home / End | Turn pages (Book mode) |
| Left / Right / Space / F / Esc | Previous 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.
- The Documents drawer lists your documents, with filter and rename.
- Version history keeps automatic snapshots, with a timeline, diff and restore.
- Open .md, .markdown or .txt files with the Open button, drag-and-drop or paste. The replaced text is always one Undo away.
- Saving to a file: in Chrome and Edge on a computer, a file you open stays linked and Lumens saves straight into it. On phones, browsers cannot write into a file you opened, so Lumens opens a copy, keeps your edits, and saves through the share sheet under the same name (on iPhone choose Save to Files, then Replace). Where sharing is not available, it downloads a copy. To see what your device supports, open the command palette and run File saving: check this device.
- A share link packs the document into the URL itself, so anyone you give the link to can read it.
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.
- Uploaded images are stored on this device, inside your browser storage. Nothing is sent to us.
- They are embedded in HTML and .md exports and in backups, so those files stand alone.
- Share links carry only text, so uploaded images do not travel in them. Linked images (https) do appear for the person you share with.
- A linked image is loaded from its own website, which can see your IP address, and it needs a connection to show.
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
- Markdown (.md)
- Standalone HTML, carrying the current theme, typography and code styling
- PDF: Export PDF opens the print dialog, choose Save as PDF. Text stays selectable; always typeset on a light page, with an optional generated cover page
- Print the preview directly
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]