refine README

This commit is contained in:
Le Tan 2018-05-01 14:23:27 +08:00
parent c1a46033c8
commit 450f6f7c18
6 changed files with 17 additions and 15 deletions

View File

@ -67,13 +67,13 @@ brew cask install vnote
```
# Description
**VNote** is a Qt-based, free and open source note-taking application, focusing on Markdown. VNote is designed to provide comfortable edit experience.
**VNote** is a Qt-based, free and open source note-taking application, focusing on Markdown. VNote is designed to provide comfortable edit experience, especially for programmers.
VNote is **NOT** just a simple editor for Markdown. By providing notes management, VNote makes taking notes in Markdown simpler and more pleasant.
Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS**.
![VNote Main Interface](screenshots/_vnotemaini_1521763751_1643978501.png)
![VNote Main Interface](screenshots/_vnotemaini_1525154456_1561295841.png)
# Supports
- [Github issues](https://github.com/tamlok/vnote/issues);
@ -86,16 +86,18 @@ Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS**.
- **Universal Entry** to reach anything just by typing;
- Inserting images directly from clipboard;
- Syntax highlights of fenced code blocks in both **edit** and **read** mode;
- Powerful **In-Place Preview** for images, diagrams, and formulas;
- Side-by-side live preview for diagrams;
- Outline in both edit and read mode;
- Custom styles in both edit and read mode;
- Vim mode and a set of powerful shortcuts;
- Infinite levels of folders;
- Multiple tabs and splitting windows;
- [Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/), and [MathJax](https://www.mathjax.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/);
- Supports HiDPI;
- Attachments of notes;
- Themes and dark mode;
- Rich and extensible export, such as HTML, PDF, and PDF (All In One);
- Rich and extensible export, such as HTML, PDF, PDF (All In One), and images;
# Donate
You could help VNote's development in many ways.
@ -149,10 +151,10 @@ VNote also supports **syntax highlight for fenced code blocks** in edit mode in
![Syntax Highlight](screenshots/_1513485266_1616037517.png)
## Live Image Preview
VNote supports previewing the image link in edit mode. With this, you could just stay in edit mode as much as possible.
## In-Place Preview
VNote supports powerful **in-place preview** for images, diagrams, and formulas in edit mode.
![Live Image Preview](screenshots/_1513485934_140085443.png)
![In-Place Preview](screenshots/_inplacepre_1525155248_405615820.png)
## 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.

View File

@ -74,7 +74,7 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能V
基于Qt框架VNote能够在主流操作系统上运行包括 **Linux**, **Windows** 以及 **macOS**
![VNote Main Interface](screenshots/_vnotemaini_1521763751_1643978501.png)
![VNote Main Interface](screenshots/_vnotemaini_1525154456_1561295841.png)
# 支持
- [Github issues](https://github.com/tamlok/vnote/issues)
@ -87,16 +87,18 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能V
- **通用入口**,通过按键操控一切;
- 直接从剪切板插入图片;
- 编辑和阅读模式下代码块的语法高亮;
- 强大的**原地预览**,包括图片、图表和公式;
- 针对图表的两边实时预览;
- 编辑和阅读模式下的大纲;
- 自定义编辑和阅读模式的样式;
- Vim模式以及一系列强大的快捷键
- 无限层级的文件夹;
- 多个标签页和窗口分割;
- [Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/) 和 [MathJax](https://www.mathjax.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/)
- 支持高分辨率;
- 笔记附件;
- 主题以及深色模式;
- 丰富、可扩展的导出包括HTMLPDF和PDF多合一
- 丰富、可扩展的导出包括HTML、PDF、PDF多合一和图片
# 捐赠
您可以通过很多途径帮助VNote的开发。
@ -150,12 +152,10 @@ VNote还支持Markdown编辑模式中代码块的语法高亮。目前的Markdow
![Syntax Highlight](screenshots/_1513485266_1616037517.png)
## 实时图片预览
VNote支持在编辑时原地预览图片链接。这样一来,您就能尽可能地留在编辑模式,避免频繁切换
## 原地预览
VNote支持在编辑时原地预览图片、图表和公式
如果想要拷贝图片,可以选取该图片,然后复制。
![Live Image Preview](screenshots/_1513485934_140085443.png)
![In-Place Preview](screenshots/_inplacepre_1525155248_405615820.png)
## 良好的图片体验
编辑时支持像其他富文本编辑器一样直接粘贴插入图片VNote会帮您管理所插入的图片。VNote将这些图片保存在和笔记同一目录下的一个指定目录中。插入图片时VNote会弹出一个窗口预览即将要插入的图片。另外当您移除笔记中的图片链接时VNote会自动删除对应的图片文件。

Binary file not shown.

Before

Width:  |  Height:  |  Size: 601 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 570 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 308 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 351 KiB