English | 简体中文
MiaoYan
Lightweight Markdown note-taking app for macOS
## 特性
- **出色**：本地优先，无数据收集，编辑与预览分屏，wikilink 双向链接，LaTeX，Mermaid
- **美观**：极简设计，三栏布局，暗黑模式，macOS 26 毛玻璃效果，沉浸式体验
- **快速**：Swift 6 原生开发，性能优于基于 Electron 的应用
- **简洁**：轻量级，版本历史，快捷键，自动格式化
## 安装
1. **Mac App Store**（付费，自动更新）：
2. **Homebrew**：
brew install --cask miaoyan
3. **GitHub Releases**：从 [GitHub Releases](https://github.com/tw93/MiaoYan/releases/latest) 下载最新的 DMG (macOS 11.5+)
这三种方式共享同一份代码库，并会接收相同的更新。安装完成后，请在 iCloud Drive、桌面云盘文件夹或您喜欢的位置创建一个 `MiaoYan` 文件夹，打开偏好设置 (⌘,)，并设置存储路径。
## 与坚果云或其他云盘同步
MiaoYan 采用本地优先策略，不要求登录 WebDAV 或云盘账号。它会直接读写您选择的 Markdown 文件夹。跨设备同步由 iCloud Drive、坚果云、Dropbox 或其他云盘客户端来处理。
- **Mac**：在坚果云桌面客户端同步的本地文件夹内创建一个 `MiaoYan` 文件夹，然后在偏好设置中将 MiaoYan 的存储位置指向它。
- **iPhone**：从系统“文件” App 中选择相同的云盘文件夹。如果某服务商没有在“文件”中提供可写入的文件夹，请使用 iCloud Drive，或在选择前先在该服务商的 App 中将该文件夹设为离线可用。
- **文件夹检查**：MiaoYan 在切换文件夹前会验证读写权限。如果该文件夹不可用，当前的存储路径将保持不变。
## 命令行工具
MiaoYan 提供了一个用于快速操作笔记的命令行界面。
```
# 安装
curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash
# 用法
miao open
# Open note or folder
miao new [text] # Create new note
miao search <query> # Search notes in terminal
miao list [folder] # List top-level folders, or markdown in folder
miao cat <title|path> # Print note content
miao update # Update CLI
```
## 编辑与预览分屏模式
支持并排编辑与预览，提供实时预览和 60fps 双向滚动同步。
**快捷切换**：按下 `⌘\` 即可瞬间切换分屏模式，或在“偏好设置” → “界面” → “编辑模式” → “分屏模式”中开启。
为什么不采用像 Typora 那样的 WYSIWYG？我们优先考虑纯粹的 Markdown 编辑体验，而且使用原生 Swift 实现 WYSIWYG 过于复杂且存在可靠性问题。分屏模式在保持纯净编辑体验的同时，也能提供即时的视觉反馈。
<img src="https://gw.alipayobjects.com/zos/k/eg/jV8Gra.png" width="100%" alt="Split Editor & Preview Mode" />
## 文档
- [Markdown 语法指南](Resources/Initial/MiaoYan%20Markdown%20Syntax%20Guide.md) - 包含高级功能的完整语法参考
- [PPT 演示模式](Resources/Initial/MiaoYan%20PPT.md) - 使用 `---` 幻灯片分隔符创建演示文稿的指南
## 支持
<details>
<summary>These lovely people already did 🐱</summary>
<br/>
<a href="https://cats.tw93.fun?name=MiaoYan"><img src="https://cdn.jsdelivr.net/gh/tw93/sponsors@main/assets/sponsors.svg" width="1000" loading="lazy" /></a>
</details>
## 鸣谢
- [glushchenko/fsnotes](https://github.com/glushchenko/fsnotes) - 初始项目结构参考
- [stackotter/swift-cmark-gfm](https://github.com/stackotter/swift-cmark-gfm) - Swift Markdown 解析器
- [simonbs/Prettier](https://github.com/simonbs/Prettier) - Markdown 格式化工具
- [raspu/Highlightr](https://github.com/raspu/Highlightr) - 语法高亮
- [TsangerType](https://tsanger.cn/product) - 仓耳今楷体（默认字体）
- [hakimel/reveal.js](https://github.com/hakimel/reveal.js) - PPT 演示框架
## 开源协议
MIT License - 欢迎自由使用和贡献。</div><div><strong>标签：</strong>Markdown, Swift, 文本编辑器, 生产力工具, 笔记应用, 防御加固</div></article></div>
<!-- 人机验证 -->
<script>
(function () {
var base = (document.querySelector('base') && document.querySelector('base').getAttribute('href')) || '';
var path = base.replace(/\/?$/, '') + '/cap-wasm/cap_wasm.min.js';
window.CAP_CUSTOM_WASM_URL = new URL(path, window.location.href).href;
})();
</script>
</body>
</html>
