1. 项目定位与用途
MiaoYan 是一款专为 macOS 设计的轻量级 Markdown 笔记应用,定位于为追求高效、纯净写作体验的用户提供原生级性能与本地数据控制。它并非简单的文本编辑器,而是集成了实时预览、富媒体渲染和演示功能的完整写作环境。用户可通过它完成从日常随笔到技术文档(含数学公式与流程图)的各类创作,同时利用 PPT 模式将笔记直接转化为演示文稿。应用强调“妙、美、快、简”四大特点:本地优先保障隐私,Swift 6 原生开发确保性能,分栏预览提升效率,极简设计减少干扰。
tw93/MiaoYan:MiaoYan 是一款专为 macOS 设计的 Swift 6 原生 Markdown 笔记应用,采用本地优先架构,提供分栏编辑预览、LaTeX本页整理它解决什么问题、适用场景、安装方式和使用方法。
MiaoYan 是一款专为 macOS 设计的 Swift 6 原生 Markdown 笔记应用,采用本地优先架构,提供分栏编辑预览、LaTeX 与 Mermaid 图表支持,以轻量、快速、简洁的体验助力高效写作。
MiaoYan 是一款专为 macOS 设计的轻量级 Markdown 笔记应用,定位于为追求高效、纯净写作体验的用户提供原生级性能与本地数据控制。它并非简单的文本编辑器,而是集成了实时预览、富媒体渲染和演示功能的完整写作环境。用户可通过它完成从日常随笔到技术文档(含数学公式与流程图)的各类创作,同时利用 PPT 模式将笔记直接转化为演示文稿。应用强调“妙、美、快、简”四大特点:本地优先保障隐私,Swift 6 原生开发确保性能,分栏预览提升效率,极简设计减少干扰。
MiaoYan 主要解决 macOS 平台上 Markdown 笔记工具的三大痛点:一是性能问题,相比 Electron 套壳应用,Swift 6 原生开发带来更低的资源占用和更流畅的交互体验;二是隐私与数据控制,采用本地优先架构,所有笔记存储于用户指定位置(如 iCloud 文件夹),不收集任何数据;三是编辑与预览的平衡,通过分栏模式实现 60fps 双向滚动同步,既保持纯 Markdown 编辑的简洁性,又提供即时视觉反馈,避免 WYSIWYG 编辑器在原生实现上的复杂性与可靠性问题。
MiaoYan 适用于多种写作与知识管理场景:技术文档编辑是其主要用例,支持 LaTeX 数学公式、Mermaid 流程图、PlantUML、Markmap 等扩展语法,满足工程师与学术作者需求;日常笔记与知识管理方面,其三栏布局、深色模式、 distraction-free 设计适合长时间写作与资料整理;PPT 演示模式允许用户将 Markdown 笔记直接切换为演示视图,快速生成演示内容;此外,轻量级特性与快捷键操作也适合需要快速记录灵感、撰写博客或日志的用户。所有数据本地存储,也适合对隐私敏感的个人或团队。
MiaoYan 提供四种官方安装方式,均需 macOS 11.5 或更高版本:1)Mac App Store 下载,支持付费下载以支持开发者,开源版本功能一致;2)Homebrew 安装,执行命令 `brew install --cask miaoyan`;3)手动安装,从 GitHub Releases 页面下载最新 DMG 镜像,打开后拖拽 MiaoYan.app 至应用程序文件夹,应用已通过 Apple 公证;4)命令行工具(CLI)安装,通过脚本 `curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash` 完成,安装后使用 `miao` 命令进行终端笔记操作。首次启动需在偏好设置中配置存储文件夹。
基本使用流程:首次启动后,在 iCloud 或本地创建 `MiaoYan` 文件夹,通过偏好设置(快捷键 ⌘,)将存储位置指向该文件夹;点击左上角“新建文件夹”图标创建文档分类;在编辑器输入 Markdown 内容,右侧实时预览。关键操作包括:按 ⌘\ 快速切换分栏编辑预览模式;通过偏好设置自定义编辑模式、主题、字体、代码高亮等;使用内置 Markdown 语法指南学习高级功能。CLI 工具提供终端操作:`miao open <标题|路径>` 打开笔记,`miao new <标题> [文本]` 创建新笔记,`miao search <关键词>` 搜索,`miao list [文件夹]` 列出,`miao cat <标题|路径>` 打印内容,`miao update`
MiaoYan 是一款专为 macOS 设计的 Swift 6 原生 Markdown 笔记应用,采用本地优先架构,提供分栏编辑预览、LaTeX 与 Mermaid 图表支持,以轻量、快速、简洁的体验助力高效写作。
MiaoYan 是一款专为 macOS 设计的轻量级 Markdown 笔记应用,定位于为追求高效、纯净写作体验的用户提供原生级性能与本地数据控制。它并非简单的文本编辑器,而是集成了实时预览、富媒体渲染和演示功能的完整写作环境。用户可通过它完成从日常随笔到技术文档(含数学公式与流程图)的各类创作,同时利用 PPT 模式将笔记直接转化为演示文稿。应用强调“妙、美、快、简”四大特点:本地优先保障隐私,Swift 6 原生开发确保性能,分栏预览提升效率,极简设计减少干扰。
MiaoYan 提供四种官方安装方式,均需 macOS 11.5 或更高版本:1)Mac App Store 下载,支持付费下载以支持开发者,开源版本功能一致;2)Homebrew 安装,执行命令 `brew install --cask miaoyan`;3)手动安装,从 GitHub Releases 页面下载最新 DMG 镜像,打开后拖拽 MiaoYan.app 至应用程序文件夹,应用已通过 Apple 公证;4)命令行工具(CLI)安装,通过脚本 `curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash` 完成,安装后使用 `miao` 命令进行终端笔记操作。首次启动需在偏好设置中配置存储文件夹。
基本使用流程:首次启动后,在 iCloud 或本地创建 `MiaoYan` 文件夹,通过偏好设置(快捷键 ⌘,)将存储位置指向该文件夹;点击左上角“新建文件夹”图标创建文档分类;在编辑器输入 Markdown 内容,右侧实时预览。关键操作包括:按 ⌘\ 快速切换分栏编辑预览模式;通过偏好设置自定义编辑模式、主题、字体、代码高亮等;使用内置 Markdown 语法指南学习高级功能。CLI 工具提供终端操作:`miao open <标题|路径>` 打开笔记,`miao new <标题> [文本]` 创建新笔记,`miao search <关键词>` 搜索,`miao list [文件夹]` 列出,`miao cat <标题|路径>` 打印内容,`miao update`