Paperling

Razee4315Apache-2.0活跃维护

基于 Tauri + React + TypeScript 的极简 Markdown 编辑器,界面干净无干扰,支持 KaTeX 公式和 Mermaid 图表,适合专注写作与记笔记。

A minimal, distraction-free markdown editor built with Tauri, React, and TypeScript

v1.2.0发布于 2026-10-31 12:05 UTC596star +3 / 7 天40fork同步于 2026-11-10 11:57 UTC

怎么上手

由 README 提炼,执行前请确认
git clone https://github.com/Razee4315/Paperling.git
cd Paperling
bun install
bun run tauri dev
硬件要求按 README 说明

README 未说明具体硬件要求;支持 Windows、macOS、Linux 与 Android 平台。

支持 Apple Silicon
下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

开箱即用的 Markdown 阅读与编辑器,打开 .md 文件即可美观阅读并实时预览编辑

基于 Tauri + React + TypeScript 的极简 Markdown 编辑器,界面干净无干扰,支持 KaTeX 公式和 Mermaid 图表,适合专注写作与记笔记。

核心能力

  • Reader/Code/Split 三视图切换,双向滚动同步
  • 实时渲染数学、化学公式与 Mermaid 图表
  • 可选免费 AI 内联提出修改,逐条接受或拒绝
  • 支持表格可视化编辑、多光标与文件夹级查找替换
  • 基于 Tauri + Rust 构建,体积轻量无插件体系

容易踩的坑

从源码构建需先安装 bun 与 Tauri 所需的 Rust 工具链;AI 功能需自备模型(bring your own model),并非内置;普通用户可直接从 releases 页面下载安装包或 Android APK,无需自行构建。

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

5 个版本v1.2.0
  1. v1.2.0Paperling v1.2.0最新正式版2026-10-31 · 2026-10-31 12:05 UTC

    What's new in v1.2.0

    Paperling 1.2 opens more of your files, keeps earlier versions of them, and fills in the everyday gaps.

    • Open HTML files. Pages show with their own styles, in a locked-down view where scripts can't run (#295).
    • File history. Earlier versions of your files stay on this computer, with a diff and one-click restore. Find it in the command palette.
    • More files open. UTF-16 and Windows-1252 notes open normally and save back the same way (#297).
    • Notes refresh on their own when another program changes them (#263), and images update when you come back to the window (#266).
    • Editing. Fold sections, :rocket: emoji shortcodes, tables of contents with [TOC], sort lines, change case, and insert the date.
    • Your files. Recent files in the Options menu (#281), recent folders, and a filter in the Files panel.
    • Sharing. Copy as rich text or HTML, and add your own custom CSS.
    • Fixes for wide code blocks (#294), clipped list numbers (#270), dragging tabs on macOS (#263) and copying from Reader (#267), plus stricter handling of remote images and safer saves.

    Your current settings are kept when you update.

    Full release notes

    Thank you

    To @leewaichong and @itshakemd for their fixes and features, and to @310394-source for the report that fixed ordered lists.

    Installation

    • Windows: .msi (recommended) or .exe (NSIS installer)
    • Linux: .deb or .AppImage
    • macOS: .dmg (Apple Silicon + Intel, universal)
    • Android: Paperling_1.2.0_aarch64.apk attached below (arm64-v8a; allow "install unknown apps" once)

    See the CHANGELOG for the full history.

  2. v1.1.1Paperling v1.1.12026-10-09 · 2026-10-09 14:15 UTC
    查看更新说明

    What's new in v1.1.1

    • macOS: a real Mac window. The red, yellow and green buttons are back, at the left of the title bar, and the green one (or ⌃⌘F) takes Paperling into true fullscreen, with the menu bar and the Dock out of the way (#262).

    Installation

    • Windows: .msi (recommended) or .exe (NSIS installer)
    • Linux: .deb or .AppImage
    • macOS: .dmg (Apple Silicon + Intel, universal)
    • Android: Paperling_1.1.1_aarch64.apk attached below (arm64-v8a; allow "install unknown apps" once)

    See the CHANGELOG for the full history.

  3. v1.1.0Paperling v1.1.02026-10-02 · 2026-10-02 06:22 UTC
    查看更新说明

    What's new in v1.1.0

    Paperling 1.1 is about the basics: reading, editing and saving feel right from the first minute.

    • Edit while you read. Double-click a sentence in Reader to fix it in place.
    • Saving you can see. A Save button, and autosave on for new installs.
    • Zoom. Ctrl + / Ctrl -, or Ctrl + mouse wheel.
    • Open a folder, with Files and Outline side by side.
    • Follows your system's light or dark theme, with a calmer title bar and settings menu.
    • Fixes for touchscreen PCs, macOS double-click, and Android open, save and keyboard.

    Your current settings are kept when you update.

    Full release notes

    Thank you

    To @leewaichong and @Gracy769 for their fixes, and to @Schadenfreund, @trymeouteh and @user-7510 for the reports that shaped this release.

    Installation

    • Windows: .msi (recommended) or .exe (NSIS installer)
    • Linux: .deb or .AppImage
    • macOS: .dmg (Apple Silicon + Intel, universal)
    • Android: Paperling_1.1.0_aarch64.apk attached below (arm64-v8a; allow "install unknown apps" once)

    See the CHANGELOG for the full history.

  4. v1.0.51Paperling v1.0.512026-09-26 · 2026-09-26 19:03 UTC
    查看更新说明

    What's new in v1.0.51

    Android: one-time reinstall (please read before updating)

    This Android update is signed with a new key, so Android will not install it over version 1.0.50 ("App not installed"). You need to uninstall 1.0.50 first, and uninstalling deletes the notes stored inside the app, so save them out first:

    1. In Paperling 1.0.50, open each note and choose Menu → Save as… → Save to Downloads. This saves the note as a .md file in your Downloads folder, which is kept when the app is removed.
    2. Uninstall Paperling 1.0.50, then install Paperling_1.0.51_aarch64.apk.
    3. Open your notes again with Menu → Open from device… and pick them from Downloads.

    The new key is stored permanently, so future Android updates install normally over this one. Desktop (Windows, macOS, Linux) updates as usual.

    Added

    • Right-to-left languages. Arabic, Hebrew, Persian and Urdu now read the right way round. Each line in the editor, and each paragraph, heading, list, quote and table in Reader, follows the language it is written in, so mixed notes just work, and code always stays left-to-right. In the editor, Ctrl+Right Shift switches the whole note to right-to-left and Ctrl+Left Shift goes back to automatic, as in other Windows editors, and Settings → Editor → "Text direction" lets you pick Auto, LTR or RTL for good. Exports keep the direction. (#216)
    • Nothing is lost in a crash. Unsaved changes, including brand-new notes that were never saved, are kept safe in the background. If Paperling is force-closed, crashes or the computer restarts, your text is back the next time you open the app.
    • Replace across files. Folder search (Ctrl+Shift+F) can now replace every match in every note at once, after asking you to confirm, with a one-click "Undo replace". A whole-word option joins the search too, and .txt notes are included.
    • Manage files from the file panel. Create notes and folders, rename (F2) and delete (Delete key or right-click) without leaving Paperling. Deleted items go to a .trash folder next to them, so nothing is ever destroyed, and open tabs follow a rename.
    • Custom keyboard shortcuts. Settings → Shortcuts lets you rebind any command: click it and press the new keys. Paperling warns if the keys are already taken. Settings search now finds any setting from any page.
    • Multiple cursors. Ctrl+D (Cmd+D) selects the next occurrence of the current word so you can edit them all at once, and Ctrl/Cmd+click adds cursors. Other occurrences of a selected word are highlighted.
    • Callouts, tags and comments. > [!NOTE], > [!WARNING] and 25 other callout types render as coloured boxes (foldable with [!NOTE]-). #tags become pills that search your folder, and %%comments%% stay hidden in Reader, as in Obsidian.
    • Better diagrams. Mermaid diagrams open at their natural size instead of stretching across the page, and can be zoomed (Ctrl+scroll, + / -), panned, shown fullscreen, copied as a PNG or saved as an SVG.
    • Go back after following a link. Ctrl/Cmd+Alt+Left and Right, or the mouse's back and forward buttons, take you back to where you were after following a link, a search result or a backlink.
    • Follow links from the editor. Ctrl/Cmd+click a [[wikilink]], a web address or a link to another note right in the source. [[Note#Heading]] links now jump straight to the heading.
    • Keep your place when switching views. Going from Reader to Edit (and back) opens at the paragraph you were reading instead of the top of the note. Text you select in Reader is selected in the editor, ready to fix. Split view stays aligned past images, tables and code.
    • Each tab remembers its state. Caret, scroll position and undo history survive switching between tabs, and switching no longer flashes the previous note.
    • Keyboard-friendly lists and tasks. Tab and Shift+Tab nest and un-nest list item
  5. v1.0.50Paperling v1.0.502026-09-11 · 2026-09-11 07:04 UTC
    查看更新说明

    What's new in v1.0.50

    Added

    • Paperling for Android. The full app, rebuilt for touch: a paper-first shell with Files / Outline / Read within thumb's reach, opening any .md from the system document picker or straight from a file manager via "Open with", saving back to your device's notes folder, Export as HTML into Downloads, system back-button handling that never eats unsaved work, and find-and-replace with proper mobile keyboard hints. The app menu carries New / Open / Save / Export / Find / Statistics / AI / Settings, Zen mode included. This first build is an arm64-v8a APK attached to the GitHub release — install it by allowing "install unknown apps" for your browser once. Modern Android phones only (Android 10+).
    • Zen mode. Press F9 (or pick it from the command palette) and everything but the page melts away: just your document, centered, in the reading typography. The canvas is editable in place with Ctrl+E, a top bar appears when you hover the screen edge, and the choice is remembered across launches.
    • Backlinks panel. The link icon in the status bar lists every note that links to the one you are reading, so following the trail backwards no longer means searching by hand.
    • Save conflicts are caught. If a file changed on disk after you opened it — another editor, a sync tool — Paperling now asks before overwriting instead of silently clobbering the newer copy, and can keep either side.
    • Unsaved tabs are marked. A tab holding unsubmitted changes shows a bullet next to its name, matching the • in the window title, so a quick glance tells you what still needs saving.
    • Optional Vim mode. Settings → Editor → "Vim mode" turns on modal editing in the editor: h/j/k/l movement, the full normal/insert/visual set, : commands. Everything else stays exactly as it was when it is off. (#119)
    • Three new themes and an accent color. Graphite, Nord and Midnight join Dark, Light, Paper and Dracula, and each theme's accent color can be tuned in Appearance. (#172)
    • Custom system fonts. Enter an installed font family in Appearance to use it across the interface, Markdown preview and exports, with Inter as a safe fallback. (#113)
    • Paperling remembers your window. Size, position and whether it was maximized are restored the next time you launch, instead of always reopening at the default 1000x700 in the middle of the screen. Thanks to @andychey.
    • Familiar shortcuts. Ctrl+F4 also closes the current tab, and F1 also opens the command palette, alongside the existing Ctrl+W and Ctrl+P. Thanks to @skycommand.
    • LM Studio preset. The AI settings now offer LM Studio next to Gemini, OpenAI and Ollama: pick it and the local server endpoint fills itself, no API key needed. (#115)
    • Chat history depth setting. Choose how many previous chat turns are sent with each AI panel message (Settings → AI, default 8). Lower it to save tokens with local models, or set 0 to make every message start fresh. (#111)
    • The AI panel is resizable. Drag its left edge to make it as wide as you need, or focus the edge and use the arrow keys. The width is remembered, and the editor reflows beside it as you drag. (#111)
    • Your chats are kept. Closing the AI panel or starting a new chat no longer throws the conversation away. Past chats are listed under the new history button in the panel header, survive restarting the app, and can be deleted individually. (#111)
    • The AI icon animation can be turned off. Settings → AI → "Animate the AI icon" switches the shimmer on the title-bar AI button off, leaving it as plain text. (#111)
    • New ways to install. Paperling is now packaged as a Nix flake (#117) and a portable Windows zip for Scoop (#48), and the macOS download is a single universal .dmg with honest Gatekeeper instructions (#94, #103).

    Fi

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    Why Paperling?

    As a developer, I frequently work with markdown files for documentation, notes, and project READMEs. The frustration of opening .md files in Notepad or basic text editors, only to see raw, unformatted text with all the symbols and syntax cluttering the content, inspired me to build Paperling.

    I wanted something you just open and write in: it renders Markdown beautifully while keeping the raw text one keystroke away. Tools like Obsidian are powerful, but vaults, graphs, and plugins are overkill if you only want to open a file and edit it. Paperling stays out of that complexity and adds the things I actually reach for: math and chemistry that render live, and an optional free AI (bring your own model) that proposes edits you accept or reject right in the text.

    The little paper fellow above lives inside the app too: it greets you on the welcome screen, gives you a 30-second tour on first launch, and naps in the corners of empty panels.

    Screenshots

    Math, chemistry, diagrams, and code — all rendered live as you type.

    Four themes

    Dark, Light, Paper, and Dracula.

    DarkLightPaper

    File explorer & command palette

    File explorerCommand palette

    Features

    Writing

    • Clean Interface — minimal UI that stays out of your way
    • Reader / Code / Split view — Ctrl+E to toggle, Ctrl+\ for split with bidirectional scroll sync
    • Focus mode — dim non-active lines so you can think
    • Typewriter mode — caret stays vertically centered
    • Formatting toolbar (toggleable) and shortcuts: Ctrl+B / Ctrl+I / Ctrl+K / Ctrl+/
    • Slash commands — type / at line start for headings, lists, tables, math, mermaid, callouts, and more
    • Auto-pair brackets, quotes, and code marks; list/quote continuation on Enter
    • Tab in tables moves between cells; auto-creates new rows
    • Visual table editing: a toolbar appears when the caret is in a table, with buttons to add or delete rows and columns, set column alignment, and tidy the layout
    • Find & Replace (Ctrl+F / Ctrl+H) with regex and match counter; replace across a whole folder from folder search (Ctrl+Shift+F)
    • Multiple cursors — Ctrl+D selects the next occurrence; Ctrl/Cmd+click adds a cursor
    • Lists and tasks from the keyboard — Tab / Shift+Tab nest items, numbered lists renumber, Ctrl+Enter ticks a task
    • Right-to-left languages — Arabic, Hebrew, Persian and Urdu lines read right-to-left automatically; Ctrl+Right Shift / Ctrl+Left Shift switch the direction
    • Smart paste — URL → link, rich HTML → markdown, TSV → GFM table
    • Folding — collapse headings, lists and code blocks from the gutter or Ctrl+Shift+[ / ]
    • Text commands — sort lines, change case, and insert the date, from the palette or the slash menu
    • Table of contents — insert one that stays linked and refreshes, or write [TOC]
    • Emoji — :rocket: renders, and typing :roc offers matches

    Preview

    • GitHub Flavored Markdown with task lists, tables, strikethrough
    • Code blocks with syntax highlighting and one-click copy; wide ones grow past the reading column
    • Math via KaTeX ($inline$, $$block$$) — loaded only when needed
    • Chemistry via mhchem — $\ce{2 H2 + O2 -> 2 H2O}$, ions, isotopes, Kröger-Vink defects
    • Mermaid diagrams (```mermaid) — flowcharts, sequence, class, state, gantt, ER, mindmaps; zoom, pan, fullscreen, copy as PNG, save as SVG
    • Callouts, #tags and %%comments%% — Obsidian-style > [!NOTE] boxes (foldable), tag pills that search your folder, hidden comments
    • Image lightbox — click to zoom; lazy loading
    • Interactive task checkboxes — toggling writes back to source
    • Heading anchors with click-to-jump
    • Wikilinks [[other-file]] and [[other-file#Heading]] resolve in the same folder; Ctrl/Cmd+click follows links in the editor too, and Ctrl+Alt+← / → go back and forward
    • Frontmatter rendered as an editable Properties card

    AI assistant

    • AI side panel — open it from the AI button next to Export (or Alt+J / ⌘J). A VS Code-style chat docked on the right; content reflows beside it.
    • Ask mode — chat about the current document: summarize it, find something, ask questions. Answers stream in live.
    • Agent mode — describe a change in plain language and the AI proposes edits. They appear as an inline diff in the editor (green added / red removed) which you review and accept or reject — per change, or all at once. Nothing is written until you approve.
    • Selection assist — select text and press Alt+J / ⌘J to rewrite, shorten, expand, continue, or translate it in place.
    • Bring your own model — works with any OpenAI-compatible endpoint: OpenAI, Google Gemini (OpenAI-compat), Ollama, llama.cpp, and more. Configure it in Settings → AI; your API key is stored in the OS keychain.

    Files & workflow

    • Command palette (Ctrl+P) — search commands, files, headings, toggles
    • Cheatsheet (?) — every shortcut categorized and searchable
    • Settings modal (Ctrl+,) — sidebar nav with Appearance / Editor / AI / About
    • New File (Ctrl+N) and Save As (Ctrl+Shift+S)
    • Auto-save (optional, debounced) with status indicator
    • External-change detection — reload or keep your version when the file changes outside the app; Paperling never silently overwrites newer work
    • Crash-safe — unsaved changes, even in never-saved notes, come back after a crash or force-quit
    • File history — earlier versions of each file, kept locally for 30 days, with a diff and one-click restore
    • HTML files — open .html pages rendered with their own styles, in a sandbox where scripts can't run
    • File encodings — UTF-16 and Windows-1252 notes open normally and save back unchanged
    • Copy as rich text or HTML — paste a whole document into Word, Gmail or Google Docs with its formatting
    • Recent files on the welcome screen — missing files marked
    • Restore last opened file on launch
    • File Explorer with folder navigation, a filter, recent folders, new note / new folder, rename (F2) and move to trash
    • Custom keyboard shortcuts — rebind any command in Settings → Shortcuts
    • Outline pane that follows the cursor
    • Backlinks panel showing which notes in the current folder link to the open file

    Customization

    • Seven themes — Dark, Graphite, Nord, Midnight, Light, Paper, Dracula — with an adjustable accent color
    • Five bundled fonts plus custom system fonts — Inter, Merriweather, Lora, Source Serif, Fira Sans, or a locally installed family
    • Four font sizes and an optional readable line length column
    • Custom CSS — add your own styles in Settings
    • WCAG-friendly — visible focus rings, prefers-reduced-motion respected

    Platform

    • Native performance — built with Tauri
    • Cross-platform — Windows, macOS, Linux, and Android (arm64)

    Installation

    Download the latest release from the Releases page.

    Available Formats

    PlatformFormats
    Windows.msi installer · .exe (NSIS) installer
    macOS.dmg (Apple Silicon + Intel, universal)
    Linux.AppImage · .deb · .rpm
    Android.apk (arm64-v8a; allow "install unknown apps" once when installing)

    Note: builds aren't code-signed yet, so Windows SmartScreen or macOS Gatekeeper may warn on first launch. On Windows choose More info → Run anyway.

    macOS: recent macOS versions report an unsigned app as "damaged and can't be opened" — right-click → Open does not clear that message. After copying the app to /Applications, run this once in Terminal and it opens normally:

    xattr -cr /Applications/Paperling.app
    

    (Alternatively: System Settings → Privacy & Security → Open Anyway.) This is a consequence of shipping without Apple's paid notarization, not a broken download. Auto-update packages are signed and verified before installing.

    Development

    Prerequisites

    Setup

    # Clone the repository
    git clone https://github.com/Razee4315/Paperling.git
    cd Paperling
    
    # Install dependencies
    bun install
    
    # Run in development mode
    bun run tauri dev
    
    # Build for production
    bun run tauri build
    

    Keyboard Shortcuts

    A few essentials — press ? inside the app for the full searchable list.

    ActionShortcut
    Command paletteCtrl+P
    Cheatsheet?
    SettingsCtrl+,
    New fileCtrl+N
    Open fileCtrl+O
    SaveCtrl+S
    Save AsCtrl+Shift+S
    Toggle Reader / CodeCtrl+E
    Toggle Split viewCtrl+\
    File explorer / OutlineCtrl+Shift+E / Ctrl+Shift+O
    Find / ReplaceCtrl+F / Ctrl+H
    Bold / Italic / LinkCtrl+B / Ctrl+I / Ctrl+K
    Toggle blockquoteCtrl+/
    AI panel / assistAlt+J (Windows) · ⌘J (macOS/Linux)

    Tech Stack

    • Frontend: React, TypeScript, Tailwind CSS
    • Backend: Rust, Tauri v2
    • Build: Vite

    Contributing

    Contributions are very welcome — code, docs, bug reports, or ideas.

    Even a ⭐ helps others discover the project.

    Author

    Saqlain Abbas
    Email: [email protected]
    GitHub: @Razee4315 Linkedin: @saqlain.razee

    License

    Paperling is licensed under the Apache License 2.0: free to use, modify, and distribute for both personal and commercial purposes, with an explicit patent grant. Just keep the license and NOTICE with copies you redistribute.