dawy_go/vnote
1
0
Fork 0
mirror of https://gitee.com/vnotex/vnote.git synced 2025-07-05 13:59:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

refine README

Browse Source
This commit is contained in:
Le Tan 2017-12-17 12:56:55 +08:00
parent 6808fac920
commit d309766513
18 changed files with 25 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,5 +1,5 @@
# VNote
[中文](./README_zh.md)
[中文 Chinese](./README_zh.md)
Designed specially for **Markdown**, **VNote** is a Vim-inspired note-taking application, which knows programmers and Markdown better.
@ -35,9 +35,9 @@ There is an AppImage format standalone executable of VNote for major Linux distr
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** (due to the quite different interaction logics on macOS, VNote is not fully tested on macOS and we need more feedbacks to help improving VNote).
Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS**.
![VNote](screenshots/vnote_001.png)
![VNote](screenshots/_vnote_1513485003_1746530034.png)
# Supports
- [Github issues](https://github.com/tamlok/vnote/issues);
@ -57,8 +57,7 @@ Utilizing Qt, VNote could run on **Linux**, **Windows**, and **macOS** (due to t
- Supports [Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/), and [MathJax](https://www.mathjax.org/);
- Supports HiDPI;
- Supports attachments of notes.
![VNote Edit](screenshots/vnote_edit.gif)
- Supports themes and dark mode.
# Why VNote
## Markdown Editor & Notes Management
@ -85,8 +84,6 @@ A notebook corresponds to a self-contained folder (called the *Root Folder* of t
A notebook could have infinite levels of folders. VNote supports copying or moving folders or notes within or between notebooks.
![VNote Folder and File Panel](screenshots/vnote_002.png)
## Simple Notes Management
All your notes are managed by some plaintext configuration files and stored as plaintext files. You could access your notes without VNote. You could use external file synchronization services to synchronize your notes and import them on another machine.
@ -97,35 +94,26 @@ VNote supports accurate syntax highlight for Markdown. Tuning the style of the h
VNote also supports **syntax highlight for fenced code blocks** in edit mode in Markdown, which is **superior** than almost all current Markdown editors.
![VNote Syntax Highlight](screenshots/vnote_003.png)
![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.
You could select the image to copy it.
![VNote Live Image Preview](screenshots/vnote_004.png)
![Live Image Preview](screenshots/_1513485934_140085443.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.
![VNote Image Insertion](screenshots/vnote_005.png)
![](screenshots/_1513485753_394180887.png)
## Interactive Outline Viewer In Read & Edit Mode
VNote provides a user-friendly outline viewer for both edit and view mode. The outline viewer is a responsive item tree instead of a segment of HTML.
![VNote Outline Viewer](screenshots/vnote_006.png)
## Powerful Shortcuts
VNote supports many pleasant and powerful shortcuts which facilitate your editing, including **Vim Mode**, **Captain Mode**, and **Navigation Mode** which enable you to work without the mouse.
Please refer to the [shortcuts help](src/resources/docs/shortcuts_en.md) in the help menu for more details.
## Window Split
VNote supports infinite horizontal window splits, facilitating notes management and writing.
![VNote Window Split](screenshots/vnote_007.png)
## Highly Configurable
In VNote, almost everything is configurable, such as background color, font, and Markdown style. VNote uses a plaintext file to record all your configuration, so you could just copy that file to initialize a new VNote on another computer.

22
README_zh.md
View File

@ -1,5 +1,5 @@
# VNote
[English](./README.md)
[英文 English](./README.md)
**VNote** 是一个受Vim启发开发的专门为 **Markdown** 而优化、设计的笔记软件。VNote是一个更了解程序员和Markdown的笔记软件。
@ -38,7 +38,7 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能，V
基于Qt框架，VNote能够在主流操作系统上运行，包括 **Linux**, **Windows** 以及 **macOS**（由于macOS上很不一样的交互逻辑，VNote在macOS上并没有被充分测试，我们也希望得到更多的反馈以帮助改进VNote）。
![VNote](screenshots/vnote_001.png)
![VNote](screenshots/_vnote_1513485003_1746530034.png)
# 支持
- [Github issues](https://github.com/tamlok/vnote/issues)；
@ -58,8 +58,7 @@ VNote不是一个简单的Markdown编辑器。通过提供笔记管理功能，V
- 支持[Mermaid](http://knsv.github.io/mermaid/), [Flowchart.js](http://flowchart.js.org/) 和 [MathJax](https://www.mathjax.org/)；
- 支持高分辨率；
- 支持笔记附件。
![VNote Edit](screenshots/vnote_edit.gif)
- 支持主题以及深色模式;
# 开发VNote的动机
## Markdown编辑器与笔记管理
@ -86,8 +85,6 @@ VNote使用 **笔记本** 来管理笔记。类似于OneNote，一个笔记本
VNote支持一个笔记本中包含无限层级的文件夹。VNote支持在笔记本内或笔记本间拷贝或剪切文件夹和笔记。
![VNote Folder and File Panel](screenshots/vnote_002.png)
## 直观的笔记管理
所有笔记被保存为纯文本而且通过纯文本的配置文件进行管理。即使没有VNote，您也能方便访问您的数据。这样，您也可以使用第三方的文件同步服务来同步您的笔记，并在另一台计算机上导入到VNote中。
@ -98,35 +95,28 @@ VNote支持精确的Markdown语法高亮。通过精心调试的高亮样式，V
VNote还支持Markdown编辑模式中代码块的语法高亮。目前的Markdown编辑器中绝大部分都尚不支持该特性。
![VNote Syntax Highlight](screenshots/vnote_003.png)
![Syntax Highlight](screenshots/_1513485266_1616037517.png)
## 实时图片预览
VNote支持在编辑时原地预览图片链接。这样一来，您就能尽可能地留在编辑模式，避免频繁切换。
如果想要拷贝图片，可以选取该图片，然后复制。
![VNote Live Image Preview](screenshots/vnote_004.png)
![Live Image Preview](screenshots/_1513485934_140085443.png)
## 良好的图片体验
编辑时，支持像其他富文本编辑器一样直接粘贴插入图片，VNote会帮您管理所插入的图片。VNote将这些图片保存在和笔记同一目录下的一个指定目录中。插入图片时，VNote会弹出一个窗口预览即将要插入的图片。另外，当您移除笔记中的图片链接时，VNote会自动删除对应的图片文件。
![VNote Image Insertion](screenshots/vnote_005.png)
![](screenshots/_1513485753_394180887.png)
## 编辑和阅读模式中的交互式大纲视图
VNote为编辑和预览模式都提供了一个用户友好的大纲视图。该大纲视图是一个项目树，而不是简单地插入一段HTML。
![VNote Outline Viewer](screenshots/vnote_006.png)
## 强大的快捷键
VNote提供很多快捷键，从而提供一个愉悦的编辑体验。其中包括 **Vim模式**、**舰长模式** 和 **导航模式**，它们能让您完全摆脱鼠标进行操作。
更多细节请参考帮助菜单中的[快捷键帮助](src/resources/docs/shortcuts_zh.md)。
## 窗口分割
VNote支持无限水平窗口分割，方便您进行笔记的整理和撰写。
![VNote Window Split](screenshots/vnote_007.png)
## 高度可定制
VNote中，几乎一切都是可以定制的，例如背景颜色、字体以及Markdown样式等。VNote使用一个纯文本文件来记录您的所有配置，因此通过拷贝该文件就能够很快地在另一台电脑上初始化一个新的VNote。

12
changes.md
View File

@ -1,4 +1,16 @@
# Changes History
## v1.11
- Support themes;
- Three built-in mordern themes;
- One dark mode theme;
- Vim mode
- Support block cursor in Normal/Visual mode;
- `=` to auto-indent selected lines as the first line;
- Support custom external editors to open notes;
- Enable `Ctrl+C`/`Ctrl+V` in Vim mode to copy/paste;
- Support Flash Page to record ideas quickly;
- Support previewing inline images;
## v1.10
- Migrate to Qt 5.9.1;
- Support Compact mode in main window;

BIN
screenshots/_1513485266_1616037517.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 198 KiB

BIN
screenshots/_1513485753_394180887.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 533 KiB

BIN
screenshots/_1513485934_140085443.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 601 KiB

BIN
screenshots/_vnote_1513485003_1746530034.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 291 KiB

BIN
screenshots/vnote_001.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 332 KiB

BIN
screenshots/vnote_002.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 46 KiB

BIN
screenshots/vnote_003.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 58 KiB

BIN
screenshots/vnote_004.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 345 KiB

BIN
screenshots/vnote_005.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 127 KiB

BIN
screenshots/vnote_006.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 33 KiB

BIN
screenshots/vnote_007.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 955 KiB

BIN
screenshots/vnote_edit.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 642 KiB

3
src/resources/themes/v_moonlight/v_moonlight.mdhl
View File

@ -92,15 +92,12 @@ foreground: e06c75
LINK
foreground: 61afef
font-style: underlined
AUTO_LINK_URL
foreground: 61afef
font-style: underlined
AUTO_LINK_EMAIL
foreground: 61afef
font-style: underlined
IMAGE
foreground: 4883b3

3
src/resources/themes/v_pure/v_pure.mdhl
View File

@ -92,15 +92,12 @@ foreground: 0000ff
LINK
foreground: 005fff
font-style: underlined
AUTO_LINK_URL
foreground: 005fff
font-style: underlined
AUTO_LINK_EMAIL
foreground: 005fff
font-style: underlined
IMAGE
foreground: 616161

3
src/resources/themes/v_white/v_white.mdhl
View File

@ -91,15 +91,12 @@ foreground: 0000ff
LINK
foreground: 005fff
font-style: underlined
AUTO_LINK_URL
foreground: 005fff
font-style: underlined
AUTO_LINK_EMAIL
foreground: 005fff
font-style: underlined
IMAGE
foreground: 616161