{"id":15037604,"url":"https://github.com/tw93/miaoyan","last_synced_at":"2025-05-14T07:08:22.470Z","repository":{"id":37036048,"uuid":"253461233","full_name":"tw93/MiaoYan","owner":"tw93","description":"⛷ Lightweight Markdown app to help you write great sentences. ⛷ 轻灵的 Markdown 笔记本伴你写出妙言","archived":false,"fork":false,"pushed_at":"2025-04-03T06:14:38.000Z","size":1989302,"stargazers_count":6036,"open_issues_count":40,"forks_count":351,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-05-12T07:57:01.863Z","etag":null,"topics":["editor","local-first","macos","markdown","markdown-editor","notes-app","swift"],"latest_commit_sha":null,"homepage":"https://miaoyan.app","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tw93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["tw93"],"custom":["https://miaoyan.app/cats.html"]}},"created_at":"2020-04-06T10:12:33.000Z","updated_at":"2025-05-12T03:45:57.000Z","dependencies_parsed_at":"2023-02-12T07:45:19.628Z","dependency_job_id":"1f58486f-5bb3-4fb6-8080-327260ab350d","html_url":"https://github.com/tw93/MiaoYan","commit_stats":{"total_commits":1385,"total_committers":10,"mean_commits":138.5,"dds":"0.015884476534296033","last_synced_commit":"c16bbe1da989a867223264804185c7036459dd47"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2FMiaoYan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2FMiaoYan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2FMiaoYan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tw93%2FMiaoYan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tw93","download_url":"https://codeload.github.com/tw93/MiaoYan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254092775,"owners_count":22013290,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["editor","local-first","macos","markdown","markdown-editor","notes-app","swift"],"created_at":"2024-09-24T20:35:05.656Z","updated_at":"2025-05-14T07:08:22.446Z","avatar_url":"https://github.com/tw93.png","language":"Swift","funding_links":["https://github.com/sponsors/tw93","https://miaoyan.app/cats.html"],"categories":[],"sub_categories":[],"readme":"\u003ch4 align=\"right\"\u003e\u003cstrong\u003e\u003ca href=\"https://github.com/tw93/MiaoYan/blob/master/README_EN.md\"\u003eEnglish\u003c/a\u003e\u003c/strong\u003e | 中文 | \u003cstrong\u003e\u003ca href=\"https://github.com/tw93/MiaoYan/blob/master/README_JP.md\"\u003e日本語\u003c/a\u003e\u003c/strong\u003e\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://miaoyan.app/\" target=\"_blank\"\u003e\u003cimg src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 /\u003e\u003c/a\u003e\n  \u003ch1 align=\"center\"\u003e妙言\u003c/h1\u003e\n  \u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/HiTw93\" target=\"_blank\"\u003e\n      \u003cimg alt=\"twitter\" src=\"https://img.shields.io/badge/follow-Tw93-red?style=flat-square\u0026logo=Twitter\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://t.me/+GclQS9ZnxyI2ODQ1\" target=\"_blank\"\u003e\n      \u003cimg alt=\"telegram\" src=\"https://img.shields.io/badge/chat-telegram-blueviolet?style=flat-square\u0026logo=Telegram\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://github.com/tw93/MiaoYan/releases\" target=\"_blank\"\u003e\n      \u003cimg alt=\"GitHub downloads\" src=\"https://img.shields.io/github/downloads/tw93/MiaoYan/total.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/tw93/MiaoYan/commits\" target=\"_blank\"\u003e\n      \u003cimg alt=\"GitHub commit\" src=\"https://img.shields.io/github/commit-activity/m/tw93/MiaoYan?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/tw93/MiaoYan/issues?q=is%3Aissue+is%3Aclosed\" target=\"_blank\"\u003e\n      \u003cimg alt=\"GitHub closed issues\" src=\"https://img.shields.io/github/issues-closed/tw93/MiaoYan.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003cimg alt=\"Minimum supported version\" src=\"https://img.shields.io/badge/macOS-10.15%2B-orange?style=flat-square\"\u003e\n  \u003c/div\u003e\n  \u003cdiv align=\"center\"\u003e轻灵的 Markdown 笔记本伴你写出妙言~\u003c/div\u003e\n\u003c/p\u003e\n\n\u003cimg src=\"https://raw.githubusercontent.com/tw93/static/master/pic/miaoyan.gif\" width=\"900px\" /\u003e\n\n## 特点\n\n- 🏂 **妙**：纯本地使用、安全、语法高亮、黑暗模式、源文件保存、国际化、演示模式、[PPT 模式](#妙言-ppt)、单独编辑模式、文档自动排版、文档导出、内部跳转、图床、LaTeX、Mermaid、PlantUML、Markmap 脑图\n- 🎊 **美**：极简的设计风格，文件夹 + 文件列表 + 编辑器方式 3 列模式\n- 🚄 **快**：使用 Swift5 原生开发，相比 Web 套壳方式性能体验好\n- 🥛 **简**：很轻巧，纯编辑器输入体验，众多快捷键助你快人一步\n\n## 首次使用\n\n1. 从 \u003ca href=\"https://github.com/tw93/MiaoYan/releases\" target=\"_blank\"\u003eGitHub Releases\u003c/a\u003e 中 **下载** 最新的 dmg 安装包，macOS Big Sur 及以上版本体验更好，如安装出现问题请参考 [文档](https://zhuanlan.zhihu.com/p/135948430)，此外也支持从 `brew install miaoyan --cask` 安装。\n2. 可以在 iCloud 或根目录下创建一个 `MiaoYan` 的文件夹，打开妙言的设置，将默认存储地址修改成这个。\n3. 点击妙言左上角新增文件夹的图标，创建好自己的文档分类文件夹，就可以开始使用了。\n4. 同样假如你不习惯默认的字体，可以在设置中修改成其他的正常字体。\n\n## 快捷键\n\n#### 窗口操作\n\n- `command + 1`：收起展开目录\n- `command + 2`：收起展开文档列表\n- `command + 3`：切换编辑和预览\n- `command + 4`：切换到演示模式\n- `command + option + m`：全局唤起/隐藏妙言\n\n#### 文档操作\n\n- `command + n`：新建文档\n- `command + r`：重命名文档\n- `command + d`：复制文档\n- `command + o`：单独打开文档\n- `command + delete`：删除文档\n- `command + shift + n`：新建文件夹\n- `command + shift + l`：自动排版\n- `command + option + r`：在 Finder 中显示\n- `command + option + i`：显示字数等文档属性\n- `command + option + p`：启动妙言 PPT 预览\n\n🏂 此外还有很多快捷键 👆🏻 👇🏻 👈🏻 👉🏻 等着爱折腾的你去寻找~\n\n## 妙言 PPT\n\n\u003ca href=https://gw.alipayobjects.com/zos/k/app2/123.gif target=\"_blank\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/8736212/180579306-4f2504ee-8377-4d5c-b560-2d0d83ac12f6.gif\" width=\"100%\"\u003e\u003c/a\u003e\n\n1. 新朋友默认初始化会生成模版，如果是老朋友需升级到 1.0，可以 Copy [此文件](https://raw.githubusercontent.com/tw93/MiaoYan/master/Resources/Initial/%E5%A6%99%E8%A8%80%20PPT.md) 到妙言玩一玩。\n2. 执行 `command + option + p` 可以启动妙言 PPT 预览，也可以选中文档点击右键，选择 `妙言 PPT` 打开。\n3. 只有在有 `---` 分隔符标志的文档中，才可启用 PPT 模式，演示过程中你可以 `回车键` 预览演讲大纲，`ESC` 键可退出 PPT 模式。\n4. 你可以使用 HTML 来自定义效果，更多复杂的用法可以参考 [Reveal](https://revealjs.com/markdown/) 文档。\n\n## 为什么要做妙言\n\n- 之前有尝试过众多的笔记应用，大学时期为知笔记、印象笔记，工作时候用过 Ulysses、Quiver、MWeb、Bear、Typora，种种原因，没有找到一个习惯的 Markdown 应用，才有了做妙言的想法。\n- 本职为前端开发，会一点 iOS 开发，爱折腾，借妙言来玩一下 Swift 以及独立产品，当做一个很愉快的事情。\n- 更多介绍可见 [妙言 - 更适合工程师用的笔记应用](https://tw93.fun/2022-09-09/miaoyan.html)，很欢迎交流和建议\n\n## 支持\n\n- 我有两只猫，假如觉得妙言让你生活更美好，可以给猫 \u003ca href=\"https://miaoyan.app/cats.html\" target=\"_blank\"\u003e喂罐头 🥩🍤\u003c/a\u003e。\n- 如果你喜欢妙言，可以在 Github Star，更欢迎 [推荐](https://twitter.com/intent/tweet?text=%23%E5%A6%99%E8%A8%80%20-%20%E4%B8%80%E4%B8%AA%E7%AE%80%E6%B4%81%E5%A5%BD%E7%9C%8B%E7%9A%84%E5%BC%80%E6%BA%90%E7%9A%84%20Mac%20%20Markdown%20%E7%BC%96%E8%BE%91%E5%99%A8%EF%BC%8C%E6%B2%A1%E6%9C%89%E4%BB%BB%E4%BD%95%E5%A4%9A%E4%BD%99%E7%9A%84%E5%8A%9F%E8%83%BD%EF%BC%8C%E4%BD%BF%E7%94%A8%E5%8E%9F%E7%94%9F%20Swift%20%E5%BC%80%E5%8F%91%EF%BC%8C%E8%BD%BB%E9%87%8F%E6%80%A7%E8%83%BD%E9%AB%98%EF%BC%8C%E5%AE%89%E5%85%A8%E7%BA%AF%E6%9C%AC%E5%9C%B0%E4%BD%BF%E7%94%A8%EF%BC%8C%E5%85%B7%E5%A4%87%E8%AF%AD%E6%B3%95%E9%AB%98%E4%BA%AE%E3%80%81%E9%BB%91%E6%9A%97%E6%A8%A1%E5%BC%8F%E3%80%81%E8%87%AA%E5%8A%A8%E6%A0%BC%E5%BC%8F%E5%8C%96%E3%80%81%E5%8D%95%E7%8B%AC%E7%BC%96%E8%BE%91%E3%80%81%E6%BC%94%E7%A4%BA%E6%A8%A1%E5%BC%8F%E3%80%81%E5%9B%BE%E5%BA%8A%E7%AD%89%E5%8A%9F%E8%83%BD%E3%80%82\u0026url=https://github.com/tw93/MiaoYan) 给你志同道合的朋友使用。\n- 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取到最新的妙言更新消息，也欢迎加入 [Telegram](https://t.me/+GclQS9ZnxyI2ODQ1) 聊天群。\n\n## 感谢\n\n- \u003ca href=\"https://github.com/KristopherGBaker/libcmark_gfm\" target=\"_blank\"\u003eKristopherGBaker/libcmark_gfm\u003c/a\u003e：适用于 cmark-gfm 的 Swift 兼容框架\n- \u003ca href=\"https://github.com/raspu/Highlightr\" target=\"_blank\"\u003eraspu/Highlightr\u003c/a\u003e：语法高亮能力\n- \u003ca href=\"https://github.com/glushchenko/fsnotes\" target=\"_blank\"\u003eglushchenko/fsnotes\u003c/a\u003e：妙言部分初始化代码来源于此项目，很感谢作者\n- \u003ca href=\"https://github.com/lxgw/LxgwWenKai\" target=\"_blank\"\u003elxgw/LxgwWenKai\u003c/a\u003e：一款漂亮的开源中文字体，妙言将其作为默认字体\n- \u003ca href=\"https://github.com/michaelhenry/Prettier.swift\" target=\"_blank\"\u003emichaelhenry/Prettier.swift\u003c/a\u003e：妙言格式化能力升级成 Prettier 的思路来源\n- \u003ca href=\"https://github.com/hakimel/reveal.js\" target=\"_blank\"\u003ehakimel/reveal.js\u003c/a\u003e：妙言 PPT 底层渲染依赖此框架\n- 感谢 Vercel 给妙言 [官网](https://miaoyan.app/) 提供静态渲染能力  \n    \u003ca href=\"https://vercel.com?utm_source=tw93\u0026utm_campaign=oss\"\u003e\u003cimg\n        src=https://gw.alipayobjects.com/zos/k/wr/powered-by-vercel.svg\n        width=\"118px\"/\u003e\u003c/a\u003e\n\n# 协议\n\n- 遵循 MIT 协议\n- 请自由地享受和参与开源\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftw93%2Fmiaoyan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftw93%2Fmiaoyan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftw93%2Fmiaoyan/lists"}