Skip to content

vivalucas/mininote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MiniNote

GitHub Release License Platform

MiniNote 是一个本地优先的桌面便签应用。打开就写,保存到本机,需要时把笔记钉在桌面上,不需要账号、云同步或复杂知识库。

简体中文 | 繁體中文 | English | 日本語 | 한국어 | Deutsch | Français | Español | Português | Italiano | Русский

技术栈

  • 框架: Tauri 2 (Rust)
  • 前端: React 19 + TypeScript
  • 样式: TailwindCSS
  • 性能: 核心编辑器采用非受控架构与防抖渲染,实现长文本全速打字零卡顿体验。

适合做什么

  • 临时记想法、命令、待办、会议片段或游戏/工作提示。
  • 把常用文字固定在桌面上,随时查看和复制。
  • 用一个小便签窗口快速记录,不打断当前工作。
  • 用简单分类管理本地草稿。
  • 用 Markdown 写标题、列表、引用、代码块,再快速预览。

主要功能

  • 本地笔记库:笔记、分类和设置保存在本机,默认不需要先选择文件。
  • 快捷便签:从托盘或全局快捷键打开小窗口,可设置为在鼠标附近出现。
  • 桌面磁贴:把某条笔记固定在屏幕上,支持自定义颜色和 Markdown 渲染。
  • 极致性能:基于非受控组件架构深度重构编辑器,实现长篇文档全速打字“零卡顿”的丝滑体验。
  • Markdown 预览:适合日常结构化文本,不追求完整 Markdown IDE。
  • 文件导入导出:支持导入单个文件,或把文件夹导入为分类;支持 .mint.md.markdown.txt
  • 源文件同步保护:从外部文件导入、或导出到文件后可记录关联文件;外部文件变化会提示处理,写回前也会检查外部修改,避免静默覆盖。
  • 可调外观:主题、字号、背景图片、快捷键、关闭到托盘等都可以在设置中调整。

支持的文件格式

格式 用途
.mint MiniNote 增强文档,UTF-8 纯文本;以 Markdown 为主体
.md / .markdown Markdown 文档
.txt 标准纯文本文件

这些文件都可以用普通文本编辑器打开。MiniNote 不会把正文写成二进制、压缩包或只能由 MiniNote 读取的私有容器。

.mint 格式设计

.mint 的定位是 MiniNote 的增强 Markdown 纯文本格式。它不是完整 HTML 文件,也不是富文本文件;正文仍以 Markdown 为主,MiniNote 可以在安全边界内提供更贴近便签场景的增强能力。

设计边界:

  • 纯文本优先:文件必须保持 UTF-8 文本,可读、可复制、可用 Git diff。
  • Markdown 为主体:标题、列表、引用、代码块、表格等仍按 Markdown 书写。
  • 安全 HTML 增强:允许 <mark><u><kbd><sup><sub><details><summary> 等少量用于笔记表达的标签;禁止脚本、iframe、表单、事件属性、javascript: 链接和任意 CSS。
  • 可选 MiniNote 头部:后续需要保存标题、分类、渲染模式、磁贴颜色等 MiniNote 属性时,应使用可读的文本头部,而不是不可见的私有数据。
  • 兼容普通编辑器:其他编辑器看不懂 MiniNote 增强信息时,也应能直接阅读和编辑正文。

示例:

<!-- mininote
version: 1
renderHtml: safe
-->

# 会议记录

这是 **Markdown** 正文,也可以用 <mark>安全 HTML</mark> 做少量强调。

<details>
<summary>展开待办</summary>

- 跟进方案
- 确认时间

</details>

当前版本的 .mint 导入导出仍保持纯文本正文;上述设计用于约束后续增强,确保 .mint.md 更懂 MiniNote,但不把 MiniNote 变成富文本或网页编辑器。

安装和更新

官方预编译包发布在 GitHub Releases。1.0.0 起正式发布只提供 Windows 和 macOS 包;Linux 相关代码保留,但暂不提供官方 Linux 发布包。

Windows

  • 安装版:mininote-<version>-windows-x64-setup.exe
  • 便携版:mininote-<version>-windows-x64.exe

安装版适合长期使用;便携版适合临时试用或放在固定目录直接运行。

macOS

Apple Silicon 设备下载 mininote-<version>-macos-arm64.dmg,打开后把 MiniNote.app 拖到 Applications

当前 macOS 包没有正式签名。如果系统提示应用无法打开、已损坏,或提示来自未验证开发者,请先确认文件来自本项目 Release,然后在终端执行:

xattr -cr /Applications/MiniNote.app

再重新打开应用。更新时退出 MiniNote,下载新版 DMG 后覆盖 Applications 中的旧版本。

Linux

1.0.0 暂不发布 Linux 安装包。需要 Linux 版本时,可以从源码自行构建;Linux 打包配置仍保留在仓库中。

数据存在哪里

MiniNote 不上传笔记,不提供云同步。笔记、配置和索引默认保存在系统应用数据目录下的 MiniNote 文件夹中。设置 MININOTE_DATA_DIR 环境变量后,MiniNote 会使用该位置作为数据目录。

从源码构建

需要 Node.js、Rust 和 Tauri 所需的系统依赖。

npm ci
npm run tauri build

开发模式:

npm run tauri dev

边界

  • 不做账号和云同步。
  • 不做富文本编辑器。
  • 不做完整 Markdown IDE。
  • 不做复杂知识库、双链或协作系统。

MiniNote 的目标是轻、快、本地、顺手。

License

MIT License

About

A lightweight local desktop note app with quick notes, pinned tiles, Markdown preview, and plain-text import/export.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors