quiet-md README

The project's README from github.com/s1dashu/quiet-md. As one markdown file: README.md.

quiet.md

一个又快又安静的本地笔记应用。
Rust + GPUI 原生绘制,笔记全部存在你的电脑上,兼容飞书文档的 DocxXML 格式。

最新版本 CI 状态 支持 macOS 和 Windows 使用 Rust 和 GPUI 构建 MIT 许可 Beta

下载 macOS 版   下载 Windows 版

官网 · 下载 · 性能 · 功能 · 参与开发

quiet.md 的主页:左侧是文档树,右侧按网格排列所有笔记。

[!NOTE] quiet.md 目前是 Beta 版本,还在快速迭代。遇到 bug 或有想法,欢迎提 issue,更欢迎直接提 PR,一起把它打磨好。

为什么是 quiet.md

⚡ 快,原生的那种快。 整个界面由 Rust 和 GPUI 直接用 GPU 绘制,没有 WebView、没有 Electron。百万字文档实测中,输入、删除和滚动的帧处理 P95 均低于 6 ms。

🔒 本地优先,文件归你。 没有账号,没有云端,默认不联网。文档库就是电脑上的一个普通文件夹,每篇笔记是一个 XML 文件。用 Git、iCloud、坚果云或任何同步工具管理都可以,哪天不用了,文件也还在。

📝 兼容飞书 DocxXML,完整的富文本编辑器。 笔记直接以飞书文档的 DocxXML 格式保存,从飞书复制粘贴、导入导出都能保留结构。标题、待办、表格、分栏、高亮块、代码、公式、图片和附件,写文档常用的块都有。

下载

下载 macOS 版   下载 Windows 版

平台 系统要求
macOS(Apple Silicon) macOS 13 及以上
Windows(x64) Windows 10 2004 及以上

也可以在官网 quiet.md 下载。所有版本和 SHA-256 校验值见 GitHub Releases。Intel Mac 暂无安装包,可以从源码构建。

首次启动会在空文档库里放一套「开始指南」,十分钟带你过一遍主要功能;已有的笔记不会被覆盖。

性能

在一篇 100 万字、549 章的混合文档里连续操作 100 次,统计每帧处理耗时:

操作 P50 P95
⌨️ 连续输入 5.06 ms 5.78 ms
⌫ 连续退格 4.99 ms 5.55 ms
🖱️ 连续滚动 2.08 ms 4.14 ms

120 Hz 屏幕每帧的预算是 8.3 ms,百万字文档下的 P95 也留有余量。

macOS 安装包 约 18 MB
Windows 安装包 约 14 MB
运行时 无 WebView、无 Electron、无后台服务

Apple M5 Pro / 48 GiB,macOS 26.5,Release 构建。测试方法和复现脚本见 docs/PERFORMANCE.md。

功能

近期更新

每个版本的完整说明见 Releases。

你的文件在哪

默认在 ~/Documents/Quiet.md(Windows 是「文档」下的 Quiet.md)。每篇笔记是 docs/ 里的一份 XML,图片和附件在 assets/。

目录结构和格式细节见 docs/FORMAT.md。

参与开发

quiet.md 还在 Beta,有很多可以一起做的事:修 bug、补功能、适配更多平台。欢迎提 issue 和 PR。

从源码构建、测试和打包见 CONTRIBUTING.md,代码结构见 docs/ARCHITECTURE.md。

许可

代码使用 MIT 许可。第三方代码、字体和素材见 THIRD_PARTY.md。

以下内容不在 MIT 范围内,fork 时请替换:

quiet-md (s1dashu/quiet-md)

Searching Database…

What is this?quiet.md is a fast, native, local-first notes app for macOS and Windows, built with Rust and GPUI. It is compatible with Feishu/Lark's DocxXML document format. It is currently in Beta.
Is it a notes app or a framework I can build on?It is a desktop notes application, not a library. Your notes are stored as plain XML files in an ordinary folder on your computer.
How do I get it running?Download the installer from GitHub Releases or from quiet.md. On macOS, drag quiet.md.app into Applications; on Windows, run the installer. Intel Macs have no prebuilt package and need to build from source.
Do I need an account or internet connection?No account and no cloud are needed, and the app does not connect to the internet by default. Sync is up to you, via Git, iCloud, or any sync tool.
Any caveats before I try it?It is still in Beta and changing quickly. On Windows, the first launch may show a SmartScreen warning; click 'More info' then 'Run anyway'. Intel Mac has no installer yet.
Does it work on Intel Macs too?No prebuilt installer exists for Intel Macs. The macOS package is for Apple Silicon only (macOS 13 or later), so Intel users must build from source.
Why is it so fast?The UI is drawn directly on the GPU by Rust and GPUI, with no WebView and no Electron. In a 1-million-character document, the author reports P95 frame times under 6 ms for typing, deleting, and scrolling.
Can I use my Feishu documents here?Yes. Notes are saved in Feishu's DocxXML format, so you can copy and paste from Feishu, import and export, and keep the structure, including headings, to-dos, tables, columns, highlight blocks, formulas, and images.
What can I write in it?It supports headings, lists, to-dos, quotes, syntax-highlighted code blocks, LaTeX formulas, tables with merged cells, columns, images, attachments, and covers. Markdown shortcuts like # and - work, plus a / slash menu.
Can I change the look?Yes. Four built-in styles are available: Craft, Feishu, Notion, and Obsidian. You can also write your own theme in CSS; see docs/THEMES.md.
Creator
s1dashu
Size
25.8 MB
Stars
488
Age
3d
Commits · 90 Days