# 妙言：给工程师用的原生 Markdown 笔记应用

> 妙言是一款给工程师用的原生 macOS Markdown 笔记应用，文档以纯文本保存在本地，支持三栏布局、分栏编辑与预览、LaTeX、Mermaid 和快捷键。这篇聊它的功能、设计取舍，以及我为什么做它。

- 发布日期: 2022-09-09
- Author: Tw93
- HTML: https://tw93.fun/2022-09-09/miaoyan.html
- English translation: https://tw93.fun/en/2022-09-09/miaoyan.md
- 全部文章: https://tw93.fun/posts.md

---

## 太长不读

> 妙言在 [GitHub](https://github.com/tw93/MiaoYan) 开源。

妙言第一次对外介绍是在 3 个月前的 [V2EX](https://www.v2ex.com/t/858941)，从 2020 年开发后慢慢折腾着，今年 6 月份觉得可以被大家使用了就给放出来了。这期间累计发布了[20 个](https://github.com/tw93/MiaoYan/releases/)版本，解决 138 个 Issues，收获 2.2K Stars，1.7K 推友关注，交到了不少纯粹的技术朋友，现在 7K 左右用户，获得了[33 位](https://cats.tw93.fun)妙友主动喂猫。

这篇文章主要想给大家介绍一下妙言的功能清单，为啥更适合工程师使用，也包括个人对于产品本身的一些想法，关于效果展示可见文章后面的章节。

<img src="https://cdn.tw93.fun/blog/upic/x6ko88.png" width=800 alt="妙言原生三栏 Markdown 编辑器界面"/>

## 功能清单

### 编辑器方面

1. **原生代码编辑器的体验**，细调十多种 markdown 语法高亮颜色，包括文字间上下左右间距，浅色/深色模式
2. **VSCode 级别文档格式化**，借助 prettier 将 markdown 文档自动格式化排版，空格/空行/序号一键搞定
3. **原生 Swift5 开发**，相比市面大部分套壳类笔记应用性能轻快不少，安装包仅 23M
4. **文本文件保存**：文档产物全部本地纯文本保存，可以很容易的导入或者导出
5. **专注、演示、单独模式**：可以 command+2 专注模式，command+4 演示模式，command+o 单独文件模式
6. **全面兼容 Macos Ventura**，此外也支持 M1 版本的通用架构模式，各种系统兼容不成问题

### 功能方面

1. **快速写 PPT**：用 markdown 分隔符方式分页，让你半小时写完一个分享 PPT，不再纠结格式排版
2. **多类插件展示**：除去 GFM 中支持的各类语法，还支持 Markmap、LaTeX、Mermaid、PlantUML 展示，此外还可以嵌入各类 codepen、codeSandbox、youtube 等 iframe 区块
3. **图床功能**：可以在设置中配置 uPic、PicGo 、Picsee 图床，支持拖拽、复制自动上传替换地址
4. **易用的 TodoList**：直接使用 `[ ]`、`[x]` 可以很方便写 todlist，同时可以在预览界面修改状态
5. **导出 pdf 和图片**：选择文档右键可很方便导出规整的 pdf 和图片，分享给你想分享的朋友
6. **内联文档**：可以使用 `[[文章标题]]` 实现妙言文档间的内联跳转，增加文档整理上的关联性

### 易用性方面

1. **经典 3 栏布局**：支持快捷键、手势快速收起和展示，此外也可以设置自己习惯的排序方式
2. **默认好用的设置**：默认设置即好用，可以 `command+、` 打开，支持设置外观、语言、字体、存储位置、图床、预览模式、换行等风格
3. **简约效果展示**：可去设置中设置不常用的操作按钮鼠标 hover 才显示，这样让妙言看起来更纯粹
4. **设计思路**：一个编辑器并不是功能越多越好，此处做了很多看不见的克制，在功能满足情况下尽量不复杂
5. **默认好看**：相信一个有强迫症的工程师不会喜欢比较丑的应用来当做自己每天使用的工具，妙言按照我自己的设计观念，尽可能让志同道合的朋友觉得好看。

## 为啥适合工程师使用

我对于工程师的定义是「可以通过技术的方式去解决问题」的这一类有想法的人。他们很喜欢使用各类可以给自己提效、方便的工具，愿意折腾，同时也喜欢漂亮的东西。

**那么我觉得一个好用的笔记软件应该包括啥功能呢**？

1. **安全、纯本地，不依赖云服务，同时能够很好的导入导出**
2. **漂亮、易用，整体来看不是一个粗糙的 Demo，而是一个漂亮的顺手的工具**
3. **markdown 源码优先，而非富文本编辑优先，这也是优先使用编辑/预览模式的原因，这也是一种敲代码的体验**
4. **快，这里的快不仅仅是只性能好，而是操作方便，几乎所有的操作都支持快捷键来操作，省去了移动鼠标的时间**

做妙言前，一直使用 Quiver，不算好看但是很易用，不过后面作者弃坑不维护几年后，兼容性不太行了，后面有试过 Bear、MWeb、Typora、obsidian 等，个人原因还不是很习惯，就有了妙言这个产品。

**同样也期待通过妙言这个产品来表达一些自己的所思所想，有一点点像独立创作者那种感觉，从设计、编码、推广利用业余时间都自己独立去玩一遍，是一个学习的过程，同时还可以认识很多志同道合的朋友，其实挺有趣的一个过程。**

## 后续计划

1. 早日上架 AppStore，让更多朋友可以更简单下载和安装
2. 持续优化笔记本身的体验，包括偶现小问题，以及妙友们的建议，一起做一个工程师喜欢的笔记本
3. [即时编辑](https://gw.alipayobjects.com/os/k/hi/miaoyan.mp4)的能力，当前进度 60%的样子，比想象中难优化一些，等好用了就放出来
4. 妙言 iPhone 的版本，等到 1、2、3 都弄好以后，就开始搞，不会在编辑上做的复杂，更多在阅读体验。
5. 当前没有 windows 等非苹果系统的妙言计划

## 效果展示

### 整体效果

<img src="https://gw.alipayobjects.com/zos/k/4f/ch.gif" width=700 alt="妙言整体使用效果演示"/>

### 快速写 PPT

<img src="https://gw.alipayobjects.com/zos/k/app2/123.gif" width=700 alt="使用妙言快速编写 PPT"/>

### 一键格式化

<img src="https://cdn.tw93.fun/blog/upic/x4RoKi.gif" width=700 alt="妙言一键格式化 Markdown 文档"/>

### 正在做的即时编辑

<img src="https://gw.alipayobjects.com/zos/k/ir/0thdx-xps0k.gif" width=700 alt="妙言即时编辑功能演示"/>

---

**期待你喜欢上妙言，也期待你多给妙言提你认为更好用的建议，一起来做一个工程师爱用的笔记应用。**
