TipNote

面向终端 / Codex 工作流的极简置顶 Markdown 便签。写下内容、预览格式，然后一键复制回当前工作流。

A tiny always-on-top Markdown scratchpad for terminal / Codex workflows. Write, preview, and copy your notes back to the workflow in one keystroke.

使用演示 / Demo

功能 / Features

• 始终置顶的轻量 Markdown 编辑器 / A lightweight always-on-top Markdown editor
• 编辑与 GFM 预览一键切换 / One-keystroke switching between editing and GFM preview
• 自动保存草稿，支持历史记录和多份便签 / Auto-saved drafts with history and multiple notes
• 将当前 Markdown 原样复制到系统剪贴板 / Copy the raw Markdown to the system clipboard
• 可自定义全局唤起键和应用内快捷键 / Configurable global toggle and local shortcuts
• 深色和纸张两种主题 / Night and paper themes
• macOS 上隐藏 Dock 图标，适合随时唤起 / Runs quietly without a Dock icon on macOS

快速开始 / Quick start

下载并安装 / Download and install

1. 打开 Releases 页面。

2. Apple Silicon Mac 下载 TipNote_<version>_aarch64.dmg。

3. 打开 DMG，将 TipNote.app 拖入 Applications，然后启动应用。

4. 如果 macOS 首次启动提示无法验证开发者，请在 Finder 中右键点击应用并选择“打开”。

5. Open the latest release.

6. On an Apple Silicon Mac, download TipNote_<version>_aarch64.dmg.

7. Open the DMG, drag TipNote.app to Applications, and launch it.

8. If macOS cannot verify the developer on first launch, right-click the app in Finder and choose Open.

当前 Release 提供 macOS Apple Silicon（aarch64）构建；Intel Mac 或其他平台可以按下面的方式从源码构建。

The published release currently provides a macOS Apple Silicon (aarch64) build. Intel Mac and other platforms can build from source as described below.

基本用法 / Basic workflow

1. 启动 TipNote，或按 F6 全局显示 / 隐藏窗口。

2. 在编辑器中写下 Markdown 内容。

3. 按 ⌘3 或点击“预览”查看渲染结果。

4. 按 ⌘C 或点击“复制”，将原始 Markdown 放回终端、Codex 或其他应用。

5. 按 ⌘1 新建草稿；按 ⌘2 打开历史记录并切换旧内容。

6. Launch TipNote, or press F6 to show or hide it globally.

7. Write Markdown in the editor.

8. Press ⌘3 or click Preview to inspect the rendered result.

9. Press ⌘C or click Copy to put the raw Markdown back into your terminal, Codex, or another app.

10. Press ⌘1 for a new draft; press ⌘2 to open history and switch between saved notes.

快捷键 / Shortcuts

快捷键 / Shortcut	行为 / Action
F6	全局显示 / 隐藏窗口 / Show or hide the window globally
⌘C	复制当前 Markdown / Copy the current Markdown
⌘1	新建草稿 / Create a new draft
⌘2	打开或收起历史记录 / Toggle history
⌘3	编辑与预览之间切换 / Toggle edit and preview
⌘4	打开或收起设置 / Toggle settings
⌘⌥ + ↑ ↓ ← →	移动当前窗口，每次 40 px / Move the focused window by 40 px

F6 和其他快捷键都可以在“设置”中重新录制。若功能键被 macOS 占用，请尝试 fn + F6，或直接改用其他组合键。

F6 and the other shortcuts can be recorded again in Settings. If macOS treats the function key as a system action, try fn + F6 or choose another combination.

数据存储 / Local data

草稿和设置保存在本机的 tipnote.json Store 中，不需要账号，也不会依赖云端同步。

Drafts and settings are stored locally in the tipnote.json Store. No account or cloud sync is required.

从源码构建 / Build from source

需要 Node.js、npm 和 Rust/Tauri 开发环境。

You need Node.js, npm, and a Rust/Tauri development environment.

git clone https://github.com/q871795224/tip_note.git
cd tip_note
npm ci

启动开发模式 / Start the development app:

npm run tauri dev

构建前端 / Build the frontend:

npm run build

构建桌面安装包 / Build desktop bundles:

npm run tauri build

产物位于 src-tauri/target/release/bundle/，macOS DMG 通常位于 bundle/dmg/。

Build artifacts are written to src-tauri/target/release/bundle/; the macOS DMG is usually under bundle/dmg/.

贡献 / Contributing

欢迎提交 Issue 和 Pull Request 来改进 TipNote。提交前请至少运行 npm run build，如果修改了 Tauri 相关代码，再运行 npm run tauri build。

Issues and pull requests are welcome. Before submitting, run npm run build; if you changed Tauri-related code, also run npm run tauri build.

License

This repository does not declare a license yet. Please open an issue if you want to discuss an open-source license for redistribution.