Skip to content

Commit

Permalink
📝 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
tw93 committed Jun 18, 2022
1 parent f42f466 commit bf90732
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 34 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ MiaoYan.xcodeproj/xcuserdata/*
.idea/
Releases
.DS_Store
Resources/.DS_Store
.vscode/
node_modules
fonts/
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://miaoyan.vercel.app/" target="_blank"><img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 /></a>
<a href="https://miaoyan.vercel.app/" target="_blank"><img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 /></a>
<h1 align="center">妙言</h1>
<div align="center">轻灵的 Markdown 笔记本伴你写出妙言~</div>
<div align="center"><strong>中文</strong> | <a href="https://github.com/tw93/MiaoYan/blob/master/README_EN.md">English</a></div>
Expand Down Expand Up @@ -51,6 +51,7 @@

- 之前有尝试过众多的笔记应用,大学时期为知笔记、印象笔记,工作时候用过 Ulysses(无预览)、Quiver(多年不更新)、MWeb(功能复杂)、Bear(Markdown 图片等富格式不支持),种种原因,没有找到一个好用的 Markdown 应用,才有了做妙言的想法。
- 本职工作为前端开发,会一点 iOS 开发,喜欢折腾,借妙言来玩一下 Swift 以及 OSX 开发,当做一个很愉快的事情。
- 我有两只猫,一只做汤圆,一只叫可乐,假如你喜欢妙言,可以给她们 [喂罐头](https://miaoyan.vercel.app/cats.html)

## 感谢

Expand Down
1 change: 1 addition & 0 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@

- I have tried many note-taking applications before, such as WizNote, Ulysses (no preview), Quiver (not updated for years), MWeb (complicated functions), Bear (Markdown images and other rich formats are not supported), for various reasons, I did not find a good Markdown application, so I had the idea of doing MiaoYan.
- My job is front-end development, but also can develop iOS App, love to toss new things, so develop MiaoYan as a fun leisure.
- I have two cats, one is called TangYuan, and one is called Coke, if you like MiaoYan, you can give them [feed canned food](https://miaoyan.vercel.app/cats.html).

## Thanks

Expand Down
35 changes: 21 additions & 14 deletions Resources/Initial/Introduction to MiaoYan.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
<p align="center">
<img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 />
<a href="https://miaoyan.vercel.app/" target="_blank"><img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 /></a>
<h1 align="center">MiaoYan</h1>
<div align="center">Lightweight Markdown app to help you write great sentences.</div>
<div align="center"><a href="https://github.com/tw93/MiaoYan">中文</a> | <strong>English</strong></div>
</p>

![gif](https://gw.alipayobjects.com/zos/k/8m/en.gif)
<kbd>
<img src=https://gw.alipayobjects.com/zos/k/8m/en.gif width=1000>
</kbd>

## Features

- 🪂 **Fantastic**: Local use, security, syntax highlighting, dark mode, source file saving, international.
- 🪂 **Fantastic**: Local use, security, syntax highlighting, dark mode, source file saving, international, Presentation mode, document auto typesetting.
- 🐶 **Beauty**: Minimalist design style, folder + file list + editor 3 column mode.
- 🏌🏽‍♂️ **Fast**: Using Swift5 native development, the performance experience is much better compared to the Web.
- 🩴 **Simple**: Very light, pure editor input experience, many shortcut keys to help you fast.

## Download

- Download the latest `MiaoYan.dmg` installation package from [GitHub Releases](https://github.com/tw93/MiaoYan/releases) and double-click to install it.
- If the download speed is very slow in China, you can try [Vercel](https://miaoyan.vercel.app/Release/MiaoYan-V0.4.0.dmg) to download the latest version.
- Download the latest `MiaoYan.dmg` installation package from <a href="https://github.com/tw93/MiaoYan/releases" target="_blank">GitHub Releases</a> and double-click to install it.
- If the download speed is very slow in China, you can try <a href="https://miaoyan.vercel.app/Release/MiaoYan-V0.4.0.dmg" target="_blank">Vercel</a> to download the latest version.

## First Use

1. You can create a `MiaoYan` folder in iCloud or the root directory, open MiaoYan's [Settings](https://gw.alipayobjects.com/zos/k/2i/31.jpeg), and change the default storage address to this.
2. [Click](https://gw.alipayobjects.com/zos/k/66/43.jpeg) icon of the new folder in the upper left corner of MiaoYan, create your own document category folder, and you can start using it.
1. You can create a `MiaoYan` folder in iCloud or the root directory, open MiaoYan's Settings, and change the default storage address to this.
2. Click icon of the new folder in the upper left corner of MiaoYan, create your own document category folder, and you can start using it.
3. Similarly, if you are not used to the default font, you can change it to other normal fonts in the settings.

## Shortcut Keys

Expand All @@ -31,6 +34,7 @@
- `command + 1`: Collapse expand folder list
- `command + 2`: Expand the list of documents
- `command + 3`: Switching between edit and preview states
- `command + 4`: Switching between edit and presentation states

#### File Operations

Expand All @@ -39,23 +43,26 @@
- `command + i`: Displaying document in Finder
- `command + shift + p`: Pin document
- `command + delete`: Delete document
- `command + shift + l`:Auto typesetting

🏂 There are also many other shortcuts waiting for you to find if you like to toss and turn~

## Why do this

- I have tried many note-taking applications before, such as WizNote, Ulysses (no preview), Quiver (not updated for years), MWeb (complicated functions), Bear (Markdown images and other rich formats are not supported), for various reasons, I did not find a good Markdown application, so I had the idea of doing MiaoYan.
- My job is front-end development, but also can develop iOS App, love to toss new things, so develop MiaoYan as a fun leisure.
- I have two cats, one is called TangYuan, and one is called Coke, if you like MiaoYan, you can give them [feed canned food](https://miaoyan.vercel.app/cats.html).

## Thanks

- [KristopherGBaker/libcmark_gfm](https://github.com/KristopherGBaker/libcmark_gfm): Swift-compatible framework for cmark-gfm.
- [Remix-Design/RemixIcon](https://github.com/Remix-Design/RemixIcon): Clean and simple icon.
- [draveness/NightNight](https://github.com/draveness/NightNight): Dark Mode.
- [raspu/Highlightr](https://github.com/raspu/Highlightr): Syntax highlighting capability.
- [glushchenko/fsnotes](https://github.com/glushchenko/fsnotes): MiaoYan has part of the framework code from this.
- [hpakovski/MASShortcut](https://github.com/shpakovski/MASShortcut): Shortcut Key Plugin.
- [lxgw/LxgwWenKai](https://github.com/lxgw/LxgwWenKai): A beautiful open source Chinese font, MiaoYan has made it the default font.
- <a href="https://github.com/KristopherGBaker/libcmark_gfm" target="_blank">KristopherGBaker/libcmark_gfm</a>: Swift-compatible framework for cmark-gfm.
- <a href="https://github.com/Remix-Design/RemixIcon" target="_blank">Remix-Design/RemixIcon</a>: Clean and simple icon.
- <a href="https://github.com/draveness/NightNight" target="_blank">draveness/NightNight</a>: Dark Mode.
- <a href="https://github.com/raspu/Highlightr" target="_blank">raspu/Highlightr</a>: Syntax highlighting capability.
- <a href="https://github.com/glushchenko/fsnotes" target="_blank">glushchenko/fsnotes</a>: MiaoYan has part of the framework code from this.
- <a href="https://github.com/shpakovski/MASShortcut" target="_blank">hpakovski/MASShortcut</a>: Shortcut Key Plugin.
- <a href="https://github.com/lxgw/LxgwWenKai" target="_blank">lxgw/LxgwWenKai</a>: A beautiful open source Chinese font, MiaoYan has made it the default font.
- <a href="https://github.com/X140Yu/pangu.Swift" target="_blank">X140Yu/pangu.Swift</a>:How can you do without spaces between Chinese and English?

# License

Expand Down
43 changes: 25 additions & 18 deletions Resources/Initial/介绍妙言.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
<p align="center">
<img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 />
<h1 align="center">妙言</h1>
<div align="center">轻灵的 Markdown 笔记本伴你写出妙言~</div>
<div align="center"><strong>中文</strong> | <a href="https://github.com/tw93/MiaoYan/blob/master/README_EN.md">English</a></div>
<a href="https://miaoyan.vercel.app/" target="_blank"><img src=https://gw.alipayobjects.com/zos/k/t0/43.png width=138 /></a>
<h1 align="center">妙言 </h1>
<div align="center">轻灵的 Markdown 笔记本伴你写出妙言 ~</div>
<div align="center"><strong>中文 </strong> | <a href="https://github.com/tw93/MiaoYan/blob/master/README_EN.md">English</a></div>
</p>

![gif](https://gw.alipayobjects.com/zos/k/4f/ch.gif)
<kbd>
<img src=https://gw.alipayobjects.com/zos/k/4f/ch.gif width=1000>
</kbd>

## 特点

- 🪂 ****:纯本地使用、安全、语法高亮、黑暗模式、源文件保存、国际化
- 🪂 ****:纯本地使用、安全、语法高亮、黑暗模式、源文件保存、国际化、演示模式、文档自动排版
- 🐶 ****:极简的设计风格,文件夹 + 文件列表 + 编辑器方式 3 列模式
- 🏌🏽‍♂️ ****:使用 Swift5 原生开发,相比 Web 套壳方式性能体验好
- 🩴 ****:很轻巧,纯编辑器输入体验,众多快捷键助你快人一步

## 下载

-[GitHub Releases](https://github.com/tw93/MiaoYan/releases) 中下载最新的 MiaoYan.dmg 安装包,双击安装即可。
- 如果在国内下载速度很慢,你可以试试 [Vercel](https://miaoyan.vercel.app/Release/MiaoYan-V0.4.0.dmg) 来下载最新版本。
-<a href="https://github.com/tw93/MiaoYan/releases" target="_blank">GitHub Releases</a> 中下载最新的 MiaoYan.dmg 安装包,双击安装即可。
- 如果在国内下载速度很慢,你可以试试 <a href="https://miaoyan.vercel.app/Release/MiaoYan-V0.4.0.dmg" target="_blank">Vercel</a> 来下载最新版本。

## 初始化使用

1. 可以在 iCloud 或者根目录下 创建一个 `MiaoYan` 的文件夹,打开妙言的 [设置](https://gw.alipayobjects.com/zos/k/2i/31.jpeg),将默认存储地址修改成这个。
2. [点击](https://gw.alipayobjects.com/zos/k/66/43.jpeg) 妙言左上角新增文件夹的图标,创建好自己的文档分类文件夹,就可以开始使用了。
1. 可以在 iCloud 或根目录下创建一个 `MiaoYan` 的文件夹,打开妙言的设置,将默认存储地址修改成这个。
2. 点击妙言左上角新增文件夹的图标,创建好自己的文档分类文件夹,就可以开始使用了。
3. 同样假如你不习惯默认的字体,可以在设置中修改成其他的正常字体。

## 快捷键

Expand All @@ -31,6 +34,7 @@
- `command + 1`:收起展开目录
- `command + 2`:收起展开文档列表
- `command + 3`:切换编辑和预览
- `command + 4`:切换到演示模式

#### 文件操作

Expand All @@ -39,23 +43,26 @@
- `command + i`:在文件中显示文档
- `command + shift + p`:pin 置顶文档
- `command + delete`:删除文档
- `command + shift + l`:自动排版

🏂 此外还有很多快捷键等着爱折腾的你去寻找~
🏂 此外还有很多快捷键等着爱折腾的你去寻找 ~

## 为什么要做妙言

- 之前有尝试过众多的笔记应用,大学时期为知笔记、印象笔记,工作时候用过 Ulysses(无预览)、Quiver(多年不更新)、MWeb(功能复杂)、Bear(Markdown 图片等富格式不支持),种种原因,没有找到一个好用的 Markdown 应用,才有了做妙言的想法。
- 本职工作为前端开发,会一点 iOS 开发,喜欢折腾,借妙言来玩一下 Swift 以及 OSX 开发,当做一个很愉快的事情。
- 我有两只猫,一只做汤圆,一只叫可乐,假如你喜欢妙言,可以给她们 [喂罐头](https://miaoyan.vercel.app/cats.html)

## 感谢

- [KristopherGBaker/libcmark_gfm](https://github.com/KristopherGBaker/libcmark_gfm):适用于 cmark-gfm 的 Swift 兼容框架
- [Remix-Design/RemixIcon](https://github.com/Remix-Design/RemixIcon):简洁的 icon
- [draveness/NightNight](https://github.com/draveness/NightNight):黑暗模式
- [raspu/Highlightr](https://github.com/raspu/Highlightr):语法高亮能力
- [glushchenko/fsnotes](https://github.com/glushchenko/fsnotes):妙言部分初始化代码来源于此
- [hpakovski/MASShortcut](https://github.com/shpakovski/MASShortcut):快捷键插件
- [lxgw/LxgwWenKai](https://github.com/lxgw/LxgwWenKai):一款漂亮的开源中文字体,妙言将其作为默认字体
- <a href="https://github.com/KristopherGBaker/libcmark_gfm" target="_blank">KristopherGBaker/libcmark_gfm</a>:适用于 cmark-gfm 的 Swift 兼容框架
- <a href="https://github.com/Remix-Design/RemixIcon" target="_blank">Remix-Design/RemixIcon</a>:简洁的 icon
- <a href="https://github.com/draveness/NightNight" target="_blank">draveness/NightNight</a>:黑暗模式
- <a href="https://github.com/raspu/Highlightr" target="_blank">raspu/Highlightr</a>:语法高亮能力
- <a href="https://github.com/glushchenko/fsnotes" target="_blank">glushchenko/fsnotes</a>:妙言部分初始化代码来源于此
- <a href="https://github.com/shpakovski/MASShortcut" target="_blank">hpakovski/MASShortcut</a>:快捷键插件
- <a href="https://github.com/lxgw/LxgwWenKai" target="_blank">lxgw/LxgwWenKai</a>:一款漂亮的开源中文字体,妙言将其作为默认字体
- <a href="https://github.com/X140Yu/pangu.Swift" target="_blank">X140Yu/pangu.Swift</a>:中文和英文之间没有空格可怎么行?

# 协议

Expand Down

0 comments on commit bf90732

Please sign in to comment.