quiet-md README

项目的 README,来自 github.com/s1dashu/quiet-md。合并为一个 markdown 文件:README.md。

Quiet.md

A fast, quiet, local notes app.
Drawn natively with Rust + GPUI. Your notes stay on your computer, stored in the Feishu (Lark) DocxXML format.

English · 简体中文 · 日本語 · 한국어 · Español · Français

Latest release CI status macOS, Windows and Linux Built with Rust and GPUI MIT license Beta

Download for macOS   Download for Windows   Download for Linux

Website · Download · Performance · Features · Contributing

The Quiet.md home screen: a document tree on the left and all notes in a grid on the right.

[!NOTE] Quiet.md is in beta and changing quickly. If you hit a bug or have an idea, please open an issue — or better, send a pull request.

Why Quiet.md

⚡ Fast, the native kind of fast. The whole interface is drawn on the GPU by Rust and GPUI. No WebView, no Electron. In a one-million-character document, typing, deleting and scrolling all stay under 6 ms per frame at P95.

🔒 Local-first. Your files are yours. No account, no cloud, and nothing goes over the network by default (the optional update check aside). Your library is an ordinary folder on your computer: the sidebar's folders are real folders, and each note is a file named by its title (.xml, or .md for Markdown). Manage it with Git, iCloud or any sync tool you like; if you ever stop using Quiet.md, your files are still there.

📝 A full rich-text editor that speaks Feishu (Lark) DocxXML. Notes are saved in the DocxXML format used by Feishu (Lark) Docs, so copy-paste, import and export keep their structure. Headings, to-dos, tables, columns, callouts, code, math, images and attachments — the blocks you reach for when writing documents are all there.

Download

Download for macOS   Download for Windows   Download for Linux

Platform Package Requirements
macOS (Apple Silicon) quiet-md-macos-arm64.zip macOS 13 or later
Windows (x64) quiet-md-windows-x64-setup.exe Windows 10 version 1809 or later
Linux (x86_64, experimental) quiet-md-x86_64.AppImage glibc 2.35 or later (Ubuntu 22.04 and newer)
macOS (Intel) quiet-md-macos-x86_64.zip macOS 13 or later

You can also download from Quiet.md. Every release and its SHA-256 checksums are on GitHub Releases.

On first launch, Quiet.md asks for the interface language, where to keep your library and the quick-note shortcut, and offers to copy in notes from Obsidian, Logseq, iA Writer or Typora. An empty library gets a Getting started guide — a ten-minute tour of the main features. Existing notes are never overwritten.

The interface is available in English, Simplified Chinese, Japanese, Korean, Spanish, French and Arabic.

Performance

Frame processing time over 100 consecutive operations in a mixed document of 1 million characters and 549 chapters:

Operation P50 P95
⌨️ Typing 5.06 ms 5.78 ms
⌫ Backspace 4.99 ms 5.55 ms
🖱️ Scrolling 2.08 ms 4.14 ms

A 120 Hz display gives each frame 8.3 ms. Even at P95 on a million-character document, there is headroom left.

macOS download ~18 MB
Windows installer ~14 MB
Runtime No WebView, no Electron, no background services

Apple M5 Pro / 48 GiB, macOS 26.5, release build. Methodology and scripts to reproduce: docs/PERFORMANCE.md.

Features

Contributors

Thanks to everyone who has helped build Quiet.md. Issues and pull requests are welcome: building, testing and code conventions are in CONTRIBUTING.md.

Contributors

Recent updates

Full notes for each version are on Releases.

License

The code is licensed under MIT. Third-party code, fonts and assets are listed in THIRD_PARTY.md.

The following are not covered by the MIT license and should be replaced in forks:

quiet-md (s1dashu/quiet-md)

正在搜索数据库…

这是什么?quiet.md 是一款快速、原生、本地优先的笔记应用,适用于 macOS 和 Windows,使用 Rust 和 GPUI 构建。它兼容飞书(Feishu/Lark)的 DocxXML 文档格式。目前处于测试版(Beta)阶段。
它是笔记应用,还是可以基于它开发的框架?它是一款桌面笔记应用,而不是代码库。你的笔记以纯 XML 文件的形式保存在电脑上的一个普通文件夹中。
我该如何安装并运行它?从 GitHub Releases 或 quiet.md 官网下载安装程序。在 macOS 上,将 quiet.md.app 拖入“应用程序”文件夹;在 Windows 上,运行安装程序即可。Intel 芯片的 Mac 没有预编译安装包,需要从源代码自行构建。
我需要账号或联网吗?不需要账号,也不需要云服务,应用默认不会连接互联网。是否同步由你决定,可以通过 Git、iCloud 或任何同步工具完成。
试用前有什么需要注意的吗?它仍处于测试版阶段,变化很快。在 Windows 上首次启动时,可能会出现 SmartScreen 警告;点击“更多信息”,然后点击“仍要运行”。Intel 芯片的 Mac 目前还没有安装程序。
Intel 芯片的 Mac 也能用吗?Intel 芯片的 Mac 没有预编译安装程序。macOS 版安装包仅适用于 Apple 芯片(macOS 13 或更高版本),因此 Intel 用户必须从源代码构建。
为什么它这么快?界面由 Rust 和 GPUI 直接在 GPU 上绘制,不使用 WebView,也不基于 Electron。作者报告称,在一个 100 万字符的文档中,输入、删除和滚动时的 P95 帧时间都低于 6 毫秒。
我能在这里使用我的飞书文档吗?可以。笔记以飞书的 DocxXML 格式保存,因此你可以从飞书复制粘贴、导入和导出,并保留结构,包括标题、待办事项、表格、分栏、高亮块、公式和图片。
我可以在里面写什么内容?它支持标题、列表、待办事项、引用、带语法高亮的代码块、LaTeX 公式、支持合并单元格的表格、分栏、图片、附件和封面。也支持 # 和 - 等 Markdown 快捷输入,以及 / 斜杠菜单。
我能更改外观吗?可以。内置四种样式:Craft、飞书、Notion 和 Obsidian。你也可以用 CSS 编写自己的主题,参见 docs/THEMES.md。
作者
s1dashu
大小
59.7 MB
星标
1.9K
时长
17天
提交 · 90 天