Skip to content
ralfkuh-labPublic

About

Cross-platform Markdown viewer/editor

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

644 Commits

Folders and files

Repository files navigation

Folio

A fast, good-looking Markdown viewer and editor for macOS, Windows and Linux.

Folio opens your .md files with a clean live preview, lets you edit them in a proper code editor, and turns them into polished PDF or HTML documents. It also handles plain text, code, HTML and images, so it works well as an everyday "open this file and show it to me nicely" app — not just for Markdown.

Built with Tauri 2, so it's a small native app rather than a browser in disguise.

Folio in Split mode — editor on the left, live preview on the right, Vault sidebar and document outline


Download

Grab the installer for your platform from the Releases page:

Platform File
macOS — Apple Silicon (M1 and newer) Folio_<version>_aarch64.dmg
macOS — Intel Folio_<version>_x64.dmg
Windows Folio_<version>_x64-setup.exe (or .msi)
Linux — Debian / Ubuntu Folio_<version>_amd64.deb
Linux — Fedora / openSUSE Folio-<version>-1.x86_64.rpm
Linux — any distro (portable) Folio_<version>_amd64.AppImage

First launch: a security prompt you can safely dismiss

Folio isn't signed with a paid Apple/Microsoft certificate, so on first launch your OS shows a scary-looking warning. This is expected — here's how to get past it once:

  • macOS — right-click Folio.app → Open → confirm Open in the dialog. If it still refuses ("Folio is damaged"), run once in Terminal:

    xattr -d com.apple.quarantine /Applications/Folio.app
  • Windows — on the SmartScreen screen, click More info → Run anyway.

You only have to do this the first time.


What you can do with it

Read comfortably

  • Live GitHub-Flavored Markdown preview: task lists, tables, footnotes, frontmatter
  • Mermaid diagrams rendered right in the page
  • Tick task list checkboxes right in the preview — the source updates with them
  • Light and dark theme, plus a whole set of view themes you can switch between
  • A document outline (table of contents) you can click to jump around
  • Zen mode (Shift+F11) hides every panel when you just want to read
  • A full-width toggle in the toolbar: stay at the theme's reading width, or let wide tables use the whole window once you have collapsed the side panels

Edit properly

  • Three layouts you switch anytime: View, Edit, and Split (editor + live preview side by side)
  • A real editor under the hood (Monaco, the one from VS Code) with syntax highlighting, minimap and multi-level undo
  • A formatting toolbar for bold, italic, headings, lists, links and tables — with a built-in cheat sheet if you forget the Markdown syntax
  • Find and replace with regular expressions, in the document or just the selection
  • Paste an image straight from the clipboard and Folio saves it next to your document and inserts the link for you
  • A status bar with cursor position, word and character counts, the detected text encoding and a click-to-switch LF/CRLF button

Keep your files organized

  • A Vault sidebar: browse folders, pin the ones you use most (drag to reorder), and jump back to recent files
  • Manage files without leaving the app: new folder, rename, duplicate, move by cut & paste, delete to the system trash — open tabs follow renamed folders
  • Full-text search right below the name filter: it searches what the filter shows (a folder, a name pattern, Markdown only, changed files) or the whole vault, with regex, file-type options and jump-to-match
  • A command palette on Ctrl+P: files, > for commands, # for headings
  • Wikilinks — [[note]], [[note|alias]], [[note#heading]] and ![[image.png]] — with autocomplete, a backlinks panel and a tag browser
  • Git aware: changed and untracked files get a marker, "Show changes" opens a read-only diff against HEAD, and the tree can filter down to changed files
  • Open several files at once in tabs — reorder them by dragging, and Folio remembers them for next time
  • Files ignored by .gitignore are dimmed so your working tree stays readable

Export something you can share

  • Export to PDF or HTML with an optional cover page, headers/footers and proper code syntax highlighting
  • Pick from built-in export layouts, or design your own theme in the in-app theme editor with live preview
  • Share themes as .mdtheme files, or let the built-in AI theme author design one for you

Let AI help (optional)

  • Translate a document into one or more languages — your code blocks are protected so they come back untouched
  • AI actions: summarize, reformat, proofread, extract action items, build tables — with an editable prompt and a diff review so you always see the changes before they're applied
  • Bring your own provider and API key; keys are stored separately and never leave your machine except to call your chosen provider

Handle more than Markdown

  • Code and text files open read-only with syntax highlighting — including dotfiles and unknown extensions
  • HTML files render in a sandboxed preview
  • Images (PNG, JPG, GIF, WebP, SVG, BMP, ICO, AVIF) are shown scaled to fit, with zoom and pan
  • Binary files open as a hex dump you can search by text or byte sequence
  • Windows-1252 and UTF-16 files open and save round-trip-faithfully

Screenshots

Rendered Markdown with GFM tables, syntax-highlighted code and Mermaid diagrams:

View mode showing a table, a syntax-highlighted code block and a Mermaid flowchart

Search across every pinned folder, with the hits grouped by file:

Vault search results in the sidebar, matches highlighted per file

Wikilinks resolve across the vault; backlinks and tags show up next to the document:

A document with wikilinks, the backlinks panel on the right and the tag browser on the left

The command palette (Ctrl+P) finds files, commands and headings:

Command palette listing open tabs, recent files and vault files

Light and dark theme:

Folio in light theme Folio in dark theme

Getting started

  1. Open a file — drag a file onto the window, or use File → Open (Ctrl/Cmd+O).
  2. Switch how you look at it — Ctrl/Cmd+1 for View, 2 for Edit, 3 for Split.
  3. Pin a folder — open a folder in the Vault sidebar on the left and pin it so it's always one click away. Pinned folders are what vault search looks at. For wikilinks, backlinks and tags, right-click a pinned folder and choose Enable wikilinks & tags here — only those folders get indexed.
  4. Jump anywhere — Ctrl/Cmd+P opens the command palette; start typing a file name, > for a command or # for a heading in the current document.
  5. Export — File → Export… to turn the current document into a PDF or HTML file.

On Linux you can also register Folio's icon for .md files in your file manager (no sudo needed):

scripts/install-folio-icons.sh

Keyboard shortcuts

On macOS use Cmd instead of Ctrl.

Shortcut Action
Ctrl+O Open a file
Ctrl+S / Ctrl+Shift+S Save / Save As
Ctrl+W Close current tab
Ctrl+Q Quit
Ctrl+P Command palette (files, > commands, # headings)
Ctrl+1 / Ctrl+2 / Ctrl+3 View / Edit / Split mode
Ctrl+Tab / Ctrl+Shift+Tab Next / previous tab
Ctrl+Z / Ctrl+Shift+Z Undo / Redo
Ctrl+F / F3 Find in document / find next
Ctrl+Shift+F Open filter & search, focus the content field
Ctrl+V Paste an image into the document
F11 / Shift+F11 Fullscreen / Zen mode

Languages

Folio follows your system language automatically and ships in nine languages: English, German, Spanish, French, Portuguese (Brazil), Italian, Russian, Simplified Chinese and Japanese. To pin one instead, go to Settings → General → Language — the change applies on the next launch.


For developers

Folio is a Tauri 2 app: a Rust backend (src-tauri/src/) with a TypeScript frontend (src-tauri/web/) using the Monaco editor. Markdown is rendered by comrak; the shipped frontend bundles live in src-tauri/dist/ and are checked in.

Build from source

Prerequisites: Rust 1.80+, the Tauri CLI (cargo install tauri-cli), and on Linux libwebkit2gtk-4.1-dev. Node.js 18+ is only needed if you change the frontend.

cd src-tauri
cargo run                      # build + launch a debug build
cargo tauri build              # release binary + installers (DEB/RPM/AppImage on Linux)

Rebuild the frontend bundles only after editing src-tauri/web/:

cd src-tauri/web
npm install                    # once
npm run build                  # typecheck + bundle into ../dist/

Tests

cd src-tauri
cargo test                                 # Rust unit + integration
cargo clippy --all-targets -- -D warnings
cargo fmt --check
cd web && npm test                         # frontend (Vitest / jsdom)

The end-to-end suite (63 scenarios, Python + Pillow, visual regression) runs headless on Linux via Xvfb:

bash scripts/run-e2e.sh

Automation API

For E2E testing, Folio exposes a loopback-only HTTP server on 127.0.0.1:9876. It is always on in debug builds and requires FOLIO_AUTOMATION=1 in release builds. It's bound to localhost with Host- and Origin-header allowlists. The full route list and contract are documented in docs/automation-contract.md.

More documentation

Architecture notes and feature specs live in docs/; contributor conventions are in CLAUDE.md; open tasks are tracked in TODO.md.

License

MIT — see LICENSE.

About

Cross-platform Markdown viewer/editor

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages