update README

This commit is contained in:
Le Tan 2018-11-25 11:45:14 +08:00
parent f9e9735d5f
commit b3c3693ffc
4 changed files with 18 additions and 28 deletions

View File

@ -1,11 +1,9 @@
# VNote # VNote
- [中文 Chinese](./README_zh.md) [中文 Chinese](./README_zh.md)
- [VNote Homepage](https://tamlok.github.io/vnote)
- [Documentation](http://vnote.readthedocs.io/en/latest/)
- [Screenshots](https://tamlok.github.io/vnote/gallery.html)
- [VNote Posts](https://github.com/tamlok/vnote-posts)
Designed specially for **Markdown**, **VNote** is a Vim-inspired note-taking application, which knows programmers and Markdown better. **VNote is a note-taking application that knows programmers and Markdown better.**
For more information, please visit [**VNote's Homepage**](https://tamlok.github.io/vnote).
![VNote](screenshots/vnote.png) ![VNote](screenshots/vnote.png)
@ -86,7 +84,8 @@ Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS**.
# Supports # Supports
- [Github issues](https://github.com/tamlok/vnote/issues); - [Github issues](https://github.com/tamlok/vnote/issues);
- Email: tamlokveer at gmail.com; - Email: `tamlokveer at gmail.com`;
- [Slack](https://join.slack.com/t/vnote/shared_invite/enQtNDg2MzY0NDg3NzI4LTQ1Yzk1YjA5MjAyYTU0MjJkMTUxNmRiYWQ2YjlkOWU0ZGZlMTFlZTAxNzg0ZGUyNzI0ZGY2NDg4MmU1M2FkMDg);
- WeChat Public Account: VNote笔记 (vnote_md); - WeChat Public Account: VNote笔记 (vnote_md);
![VNote WeChat](screenshots/vnote_md.jpg) ![VNote WeChat](screenshots/vnote_md.jpg)
@ -99,7 +98,7 @@ Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS**.
- Side-by-side live preview for diagrams; - Side-by-side live preview for diagrams;
- Outline in both edit and read mode; - Outline in both edit and read mode;
- Custom styles in both edit and read mode; - Custom styles in both edit and read mode;
- Vim mode and a set of powerful shortcuts; - **Vim** mode and a set of powerful shortcuts;
- Infinite levels of folders; - Infinite levels of folders;
- Multiple tabs and splitting windows; - Multiple tabs and splitting windows;
- [Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/), [MathJax](https://www.mathjax.org/), [PlantUML](http://plantuml.com/), and [Graphviz](http://www.graphviz.org/); - [Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/), [MathJax](https://www.mathjax.org/), [PlantUML](http://plantuml.com/), and [Graphviz](http://www.graphviz.org/);
@ -117,9 +116,9 @@ You could help VNote's development in many ways.
- Last, really appreciate your donate to VNote if you think VNote really helps you and you want to help VNote. - Last, really appreciate your donate to VNote if you think VNote really helps you and you want to help VNote.
- PayPal: [PayPal.Me/vnotemd](https://www.paypal.me/vnotemd) - PayPal: [PayPal.Me/vnotemd](https://www.paypal.me/vnotemd)
- Alipay: `tamlokveer@gmail.com` - Alipay: `tamlokveer@gmail.com`
![Alipay](screenshots/alipay.png) <img src="screenshots/alipay.png" width="256px" height="256px" />
- WeChat - WeChat
![WeChat Pay](screenshots/wechat_pay.png) <img src="screenshots/wechat_pay.png" width="256px" height="256px" />
Thanks very much to [them](https://github.com/tamlok/vnote/wiki/Donate-List) who donated to VNote! Thanks very much to [them](https://github.com/tamlok/vnote/wiki/Donate-List) who donated to VNote!
@ -168,13 +167,9 @@ VNote supports powerful **in-place preview** for images, diagrams, and formulas
## Pleasant Image Experience ## Pleasant Image Experience
Just paste your image into the Markdown note, VNote will manage all other stuffs. VNote stores images in a specified folder in the same folder with the note. VNote will pop up a window to preview the image when you insert an image. Furthermore, VNote will delete the useless image files automatically after you remove the image links. Just paste your image into the Markdown note, VNote will manage all other stuffs. VNote stores images in a specified folder in the same folder with the note. VNote will pop up a window to preview the image when you insert an image. Furthermore, VNote will delete the useless image files automatically after you remove the image links.
![Pleasant Image Experience](screenshots/_1513485753_394180887.png)
## Universal Entry & Full-Text Search ## Universal Entry & Full-Text Search
VNote has powerful built-in full-text search with **Regular Expression** and **Fuzzy Search** support. The search could be executed wihtin all notebooks, current notebook, or current folder, targeted at name or content. VNote has powerful built-in full-text search with **Regular Expression** and **Fuzzy Search** support. The search could be executed wihtin all notebooks, current notebook, or current folder, targeted at name or content.
![Full-Text Search](screenshots/_1522894671_1711734243.png)
Like the `CtrlP` in Vim, VNote supports **Universal Entry** to reach anything by typing in a simple input. Like the `CtrlP` in Vim, VNote supports **Universal Entry** to reach anything by typing in a simple input.
![Universal Entry](screenshots/_universale_1522894821_465772669.png) ![Universal Entry](screenshots/_universale_1522894821_465772669.png)

View File

@ -1,11 +1,9 @@
# VNote # VNote
- [英文 English](./README.md) - [英文 English](./README.md)
- [VNote主页](https://tamlok.github.io/vnote)
- [文档](http://vnote.readthedocs.io/en/latest/)
- [使用截图](https://tamlok.github.io/vnote/gallery.html)
- [相关文章](https://github.com/tamlok/vnote-posts)
**VNote** 是一个受Vim启发开发的专门为 **Markdown** 而优化、设计的笔记软件。VNote是一个更了解程序员和Markdown的笔记软件。 **VNote是一个更懂程序员和Markdown的笔记**
更多信息,请访问 [**VNote主页**](https://tamlok.github.io/vnote) 。
![VNote](screenshots/vnote.png) ![VNote](screenshots/vnote.png)
@ -87,7 +85,8 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能V
# 支持 # 支持
- [Github issues](https://github.com/tamlok/vnote/issues) - [Github issues](https://github.com/tamlok/vnote/issues)
- 邮箱: tamlokveer at gmail.com - 邮箱: `tamlokveer at gmail.com`
- [Slack](https://join.slack.com/t/vnote/shared_invite/enQtNDg2MzY0NDg3NzI4LTQ1Yzk1YjA5MjAyYTU0MjJkMTUxNmRiYWQ2YjlkOWU0ZGZlMTFlZTAxNzg0ZGUyNzI0ZGY2NDg4MmU1M2FkMDg)
- 微信公众号: VNote笔记vnote_md - 微信公众号: VNote笔记vnote_md
![VNote WeChat](screenshots/vnote_md.jpg) ![VNote WeChat](screenshots/vnote_md.jpg)
@ -100,7 +99,7 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能V
- 针对图表的两边实时预览; - 针对图表的两边实时预览;
- 编辑和阅读模式下的大纲; - 编辑和阅读模式下的大纲;
- 自定义编辑和阅读模式的样式; - 自定义编辑和阅读模式的样式;
- Vim模式以及一系列强大的快捷键 - **Vim** 模式以及一系列强大的快捷键;
- 无限层级的文件夹; - 无限层级的文件夹;
- 多个标签页和窗口分割; - 多个标签页和窗口分割;
- [Mermaid](http://knsv.github.io/mermaid/)、 [Flowchart.js](http://flowchart.js.org/)、 [MathJax](https://www.mathjax.org/)、 [PlantUML](http://plantuml.com/) 和 [Graphviz](http://www.graphviz.org/) - [Mermaid](http://knsv.github.io/mermaid/)、 [Flowchart.js](http://flowchart.js.org/)、 [MathJax](https://www.mathjax.org/)、 [PlantUML](http://plantuml.com/) 和 [Graphviz](http://www.graphviz.org/)
@ -118,11 +117,11 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能V
- 最后如果您觉得VNote真的帮助到您并且想回馈VNote非常感谢您的捐赠。 - 最后如果您觉得VNote真的帮助到您并且想回馈VNote非常感谢您的捐赠。
- PayPal: [PayPal.Me/vnotemd](https://www.paypal.me/vnotemd) - PayPal: [PayPal.Me/vnotemd](https://www.paypal.me/vnotemd)
- 支付宝: `tamlokveer@gmail.com` - 支付宝: `tamlokveer@gmail.com`
![Alipay](screenshots/alipay.png) <img src="screenshots/alipay.png" width="256px" height="256px" />
- 微信 - 微信
![WeChat Pay](screenshots/wechat_pay.png) <img src="screenshots/wechat_pay.png" width="256px" height="256px" />
非常感谢这些VNote的 [捐赠者](https://github.com/tamlok/vnote/wiki/Donate-List) ! 非常感谢这些VNote的 [捐赠者](https://github.com/tamlok/vnote/wiki/Donate-List) !
# 开发VNote的动机 # 开发VNote的动机
## Markdown编辑器与笔记管理 ## Markdown编辑器与笔记管理
@ -169,13 +168,9 @@ VNote支持在编辑时原地预览图片、图表和公式。
## 良好的图片体验 ## 良好的图片体验
编辑时支持像其他富文本编辑器一样直接粘贴插入图片VNote会帮您管理所插入的图片。VNote将这些图片保存在和笔记同一目录下的一个指定目录中。插入图片时VNote会弹出一个窗口预览即将要插入的图片。另外当您移除笔记中的图片链接时VNote会自动删除对应的图片文件。 编辑时支持像其他富文本编辑器一样直接粘贴插入图片VNote会帮您管理所插入的图片。VNote将这些图片保存在和笔记同一目录下的一个指定目录中。插入图片时VNote会弹出一个窗口预览即将要插入的图片。另外当您移除笔记中的图片链接时VNote会自动删除对应的图片文件。
![Pleasant Image Experience](screenshots/_1513485753_394180887.png)
## 通用入口和全文搜索 ## 通用入口和全文搜索
VNote内置强大的全文搜索支持**正则表达式**和**模糊搜索**。搜索可以指定范围,包括全部笔记本、当前笔记本和当前文件夹,也可以指定目标,如名字或内容。 VNote内置强大的全文搜索支持**正则表达式**和**模糊搜索**。搜索可以指定范围,包括全部笔记本、当前笔记本和当前文件夹,也可以指定目标,如名字或内容。
![Full-Text Search](screenshots/_1522894671_1711734243.png)
类似于Vim中的`CtrlP`VNote支持**通用入口**,可以在一个输入框中进行搜索或跳转。 类似于Vim中的`CtrlP`VNote支持**通用入口**,可以在一个输入框中进行搜索或跳转。
![Universal Entry](screenshots/_universale_1522894821_465772669.png) ![Universal Entry](screenshots/_universale_1522894821_465772669.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 533 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB