mirror of
https://gitee.com/vnotex/vnote.git
synced 2025-07-05 13:59:52 +08:00
refine
This commit is contained in:
Le Tan
parent
a1b1bd5310
commit
f0ab0afe78
@ -9,4 +9,5 @@ Continuous builds on `master` branch could be found at the [Continuous Build](ht
|
||||
|
||||
Latest stable builds could be found at the [latest release](https://github.com/vnotex/vnote/releases/latest). Alternative download services are available:
|
||||
|
||||
* [Tianyi Netdisk](https://cloud.189.cn/t/Av67NvmEJVBv)
|
||||
* [Tianyi Netdisk](https://cloud.189.cn/t/Av67NvmEJVBv)
|
||||
* [Baidu Netdisk](https://pan.baidu.com/s/1Fou1flmBsQUQ8Qs9V_M6Aw) with code `note`
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
|
||||
::: alert-success
|
||||
|
||||
VNote 3.7.0 is released! Check out [what's new](https://github.com/vnotex/vnote/releases)!
|
||||
VNote 3.10.1 is released! Check out [what's new](https://github.com/vnotex/vnote/releases)!
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
# 构建 VNote
|
||||
您需要 **Qt 5.12** 或以上版本才能从源代码创建 VNote。
|
||||
# 构建VNote
|
||||
您需要**Qt 5.12**或以上版本才能从源代码创建VNote。
|
||||
|
||||
## 获取 VNote 的源代码
|
||||
VNote 的源代码可在 [GitHub](https://github.com/vnotex/vnote) 上获取。您可以下载代码的ZIP存档。请注意，VNote 依赖于某些子模块，因此您还应该下载这些模块的源代码。
|
||||
## 获取VNote的源代码
|
||||
VNote的源代码可在[GitHub](https://github.com/vnotex/vnote)上获取。您可以下载代码的ZIP存档。请注意，VNote依赖于某些子模块，因此您还应该下载这些模块的源代码。
|
||||
|
||||
推荐的方法是像以下方式使用 **git**：
|
||||
推荐的方法是像以下方式使用**git**：
|
||||
|
||||
```
|
||||
git clone https://github.com/vnotex/vnote.git vnote.git
|
||||
@ -12,16 +12,16 @@ cd vnote.git
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## 获取 Qt 5.12
|
||||
您可以从 [Qt Downloads](http://info.qt.io/download-qt-for-application-development) 获取完整的 Qt SDK。对于中国大陆用户，您可以通过 [TUNA 镜像](https://mirrors4.tuna.tsinghua.edu.cn/qt/official_releases/qt/5.12/) 加快下载速度。
|
||||
## 获取Qt 5.12
|
||||
您可以从[Qt Downloads](http://info.qt.io/download-qt-for-application-development)获取完整的Qt SDK。对于中国大陆用户，您可以通过[TUNA镜像](https://mirrors4.tuna.tsinghua.edu.cn/qt/official_releases/qt/5.12/)加快下载速度。
|
||||
|
||||
## Windows
|
||||
在 Windows 上，您需要 **Visual Studio 2015** 或更高版本来编译 VNote (Mingw **不**受支持)。
|
||||
在Windows上，您需要**Visual Studio 2015**或更高版本来编译VNote(Mingw**不**受支持)。
|
||||
|
||||
打开 **Qt Creator** 并打开 `vnote.git\vnote.pro` 作为项目。现在您已准备好调整和编译 VNote！
|
||||
打开**Qt Creator**并打开`vnote.git\vnote.pro`作为项目。现在您已准备好调整和编译VNote！
|
||||
|
||||
## Linux
|
||||
在Ubuntu中，你可以像这样从PPA获得 Qt 5.12：
|
||||
在Ubuntu中，你可以像这样从PPA获得Qt 5.12：
|
||||
|
||||
```sh
|
||||
sudo add-apt-repository ppa:beineri/opt-qt5.12.10-bionic -y
|
||||
@ -31,7 +31,7 @@ sudo apt-get -y install qt512webchannel qt512svg qt512location qt512tools qt512t
|
||||
source /opt/qt*/bin/qt*-env.sh
|
||||
```
|
||||
|
||||
然后像这样编译和安装 VNote：
|
||||
然后像这样编译和安装VNote：
|
||||
|
||||
```sh
|
||||
cd vnote.git
|
||||
@ -43,33 +43,33 @@ sudo make install
|
||||
```
|
||||
|
||||
### Fcitx
|
||||
如果您使用 **Fcitx** 作为输入方式，则需要将缺少的库 `libfcitxplatforminputcontextplugin.so` 复制到 Qt 的插件目录。
|
||||
如果您使用**Fcitx**作为输入方式，则需要将缺少的库`libfcitxplatforminputcontextplugin.so`复制到Qt的插件目录。
|
||||
|
||||
要找到 `libfcitxplatforminputcontextplugin.so` 的位置，您可以执行：
|
||||
要找到`libfcitxplatforminputcontextplugin.so`的位置，您可以执行：
|
||||
|
||||
```sh
|
||||
fcitx-diagnose | grep libfcitxplatforminputcontextplugin.so
|
||||
```
|
||||
|
||||
如果没有这样的库，您可能需要在继续之前为 Qt5 正确安装和配置 Fcitx。
|
||||
如果没有这样的库，您可能需要在继续之前为Qt5正确安装和配置Fcitx。
|
||||
|
||||
然后您需要将库文件复制到 Qt 的插件目录：
|
||||
然后您需要将库文件复制到Qt的插件目录：
|
||||
|
||||
```
|
||||
<path_to_Qt_installation_directory>/5.12.10/gcc_64/plugins/platforminputcontexts/
|
||||
```
|
||||
|
||||
### OpenSSL
|
||||
VNote 需要 **openSSL 1.0** 以实现联网。
|
||||
VNote需要**openSSL 1.0**以实现联网。
|
||||
|
||||
安装 openSSL 后，您可以找到两个库文件：
|
||||
安装openSSL后，您可以找到两个库文件：
|
||||
|
||||
```
|
||||
/usr/lib/libcrypto.so.1.0.0
|
||||
/usr/lib/libssl.so.1.0.0
|
||||
```
|
||||
|
||||
将这两个文件复制到 Qt 的库目录中：
|
||||
将这两个文件复制到Qt的库目录中：
|
||||
|
||||
```
|
||||
<path_to_Qt_installation_directory>/5.12.10/gcc_64/lib/
|
||||
@ -83,16 +83,16 @@ ln -s libssl.so.1.0.0 libssl.so
|
||||
```
|
||||
|
||||
## MacOS
|
||||
如果您更喜欢 macOS 上的命令行操作方式，则可以按照以下步骤操作。
|
||||
如果您更喜欢macOS上的命令行操作方式，则可以按照以下步骤操作。
|
||||
|
||||
1. 安装 Xcode 和 Homebrew;
|
||||
2. 通过 Homebrew 安装 Qt：
|
||||
1. 安装Xcode和Homebrew;
|
||||
2. 通过Homebrew安装Qt：
|
||||
|
||||
```
|
||||
brew install qt@5.12.10
|
||||
```
|
||||
|
||||
3. 在项目目录中，像下面那样创建 `build_macos.sh`：
|
||||
3. 在项目目录中，像下面那样创建`build_macos.sh`：
|
||||
|
||||
```sh
|
||||
QTDIR="/usr/local/opt/qt@5.12.10"
|
||||
@ -107,11 +107,11 @@ ln -s libssl.so.1.0.0 libssl.so
|
||||
make -j2
|
||||
```
|
||||
|
||||
4. 使 `build_macos.sh` 可执行并运行它：
|
||||
4. 使`build_macos.sh`可执行并运行它：
|
||||
|
||||
```sh
|
||||
chmod +x build_macos.sh
|
||||
./build_macos.sh
|
||||
```
|
||||
|
||||
5. 现在你得到了bundle路径 `path/to/project/build/src/vnote.app` 。
|
||||
5. 现在你得到了bundle路径`path/to/project/build/src/vnote.app`。
|
||||
|
||||
@ -1,20 +1,20 @@
|
||||
# 为什么需要 VNote
|
||||
## 什么是 VNote
|
||||
开始之初，VNote 是一款专为 **Markdown** 设计的 **V**im 风格笔记应用程序。它不仅仅是一个 Markdown 编辑器。 VNote 旨在成为一个带有便捷笔记管理的功能强大的 Markdown 编辑器，或者一个拥有舒适 Markdown 体验的笔记软件。
|
||||
# 为什么需要VNote
|
||||
## 什么是VNote
|
||||
开始之初，VNote是一款专为**Markdown**设计的**V**im风格笔记应用程序。它不仅仅是一个Markdown编辑器。VNote旨在成为一个带有便捷笔记管理的功能强大的Markdown编辑器，或者一个拥有舒适Markdown体验的笔记软件。
|
||||
|
||||
现在，VNote 致力于成为一个舒适的笔记平台，会逐步支持更多的文档格式。
|
||||
现在，VNote致力于成为一个舒适的笔记平台，会逐步支持更多的文档格式。
|
||||
|
||||
VNote 是免费、开源的。您可以获得适用于 Linux，Windows 和 macOS 的版本。
|
||||
VNote是免费、开源的。您可以获得适用于Linux，Windows和macOS的版本。
|
||||
|
||||
## 为什么要造另一个 Markdown 轮子
|
||||
### 关于 Markdown 的见解
|
||||
Markdown 作为一种简单的标记语言，与富文本不同，与生俱来就带有**编辑和阅读之间的鸿沟**。处理该鸿沟的方法一般有三种：
|
||||
## 为什么要造另一个Markdown轮子
|
||||
### 关于Markdown的见解
|
||||
Markdown作为一种简单的标记语言，与富文本不同，与生俱来就带有**编辑和阅读之间的鸿沟**。处理该鸿沟的方法一般有三种：
|
||||
|
||||
1. 作为一个极端，一些编辑器只是将 Markdown 视为**纯文本**。用户可能会迷失在凌乱的黑色字符中，**难于追踪**笔记的信息脉络。
|
||||
2. 大多数 Markdown 编辑器使用两个并排面板以**同时编辑和预览** Markdown 笔记。它使事情变得更加简单，因为用户可以在编辑文本的同时预览到一个美观的排版和布局。但是，两个面板可能占据整个屏幕，并且用户要不断左右移动视线，这使用户极其容易分心。
|
||||
3. 另一个极端是，一些编辑器在用户输入后马上转换 Markdown 元素，使得在使用 Markdown 时就像使用一些快捷方式在 Word 里编辑富文本文档一样。这可能与 Markdown 的设计目标相冲突。
|
||||
1. 作为一个极端，一些编辑器只是将Markdown视为**纯文本**。用户可能会迷失在凌乱的黑色字符中，**难于追踪**笔记的信息脉络。
|
||||
2. 大多数Markdown编辑器使用两个并排面板以**同时编辑和预览**Markdown笔记。它使事情变得更加简单，因为用户可以在编辑文本的同时预览到一个美观的排版和布局。但是，两个面板可能占据整个屏幕，并且用户要不断左右移动视线，这使用户极其容易分心。
|
||||
3. 另一个极端是，一些编辑器在用户输入后马上转换Markdown元素，使得在使用Markdown时就像使用一些快捷方式在Word里编辑富文本文档一样。这可能与Markdown的设计目标相冲突。
|
||||
|
||||
由于大多数编辑器选择第二种方式，因此很多用户一提起 Markdown 就会想起实时预览。这可能是一个对 Markdown 的**误解**。定位为简单的标记语言，Markdown 旨在帮助在编辑时方便跟踪文本信息，并在转换为 HTML 后进行阅读时提供漂亮的排版。
|
||||
由于大多数编辑器选择第二种方式，因此很多用户一提起Markdown就会想起实时预览。这可能是一个对Markdown的**误解**。定位为简单的标记语言，Markdown旨在帮助在编辑时方便跟踪文本信息，并在转换为HTML后进行阅读时提供漂亮的排版。
|
||||
|
||||
### VNote 的权衡方式
|
||||
VNote 尝试通过**精心调整的语法高亮和其他一些功能**来最小化鸿沟并为 Markdown 提供尽可能好的所见即所得效果。通过帮助跟踪内容，用户无需预览或者在输入后立即修改文本。
|
||||
### VNote的权衡方式
|
||||
VNote尝试通过**精心调整的语法高亮和其他一些功能**来最小化鸿沟并为Markdown提供尽可能好的所见即所得效果。通过帮助跟踪内容，用户无需预览或者在输入后立即修改文本。
|
||||
|
||||
@ -1,27 +1,27 @@
|
||||
# 主题和样式
|
||||
## 主题
|
||||
**主题**用于指定 VNote 的外观、编辑器和阅读模式的样式，以及代码块的语法高亮样式。
|
||||
**主题**用于指定VNote的外观、编辑器和阅读模式的样式，以及代码块的语法高亮样式。
|
||||
|
||||
一个主题对应于 `themes` 文件夹中的一个子文件夹。可以通过`设置`对话框中更改或者管理主题。
|
||||
一个主题对应于`themes`文件夹中的一个子文件夹。可以通过`设置`对话框中更改或者管理主题。
|
||||
|
||||
|
||||
|
||||
### 如何添加一个主题
|
||||
一个好的做法是基于一个已有的主题来进行自定义一个新的主题。复制您最喜欢的主题的文件夹到**用户配置**文件夹下面的 `themes` 文件夹下面。记得重命名该文件夹。
|
||||
一个好的做法是基于一个已有的主题来进行自定义一个新的主题。复制您最喜欢的主题的文件夹到**用户配置**文件夹下面的`themes`文件夹下面。记得重命名该文件夹。
|
||||
|
||||
### 主题的成分
|
||||
一个主题的一些关键文件：
|
||||
|
||||
- `palette.json`: 主题的调色文件，定义了主题中会用到的各种颜色；
|
||||
- `interface.qss`: 这是一个 [**Qt 样式文件**](http://doc.qt.io/qt-5/stylesheet-reference.html)，定义了所有窗口部件的外观；该文件会使用 `palette.json` 里面定义的颜色；
|
||||
- `text-editor.theme`: 文本编辑器（以及 Markdown 编辑器）的主题文件；
|
||||
- `web.css`: Markdown 阅读模式的样式文件；
|
||||
- `highlight.css`: Markdown 阅读模式的代码块语法高亮样式文件；VNote 在阅读模式使用 [Prism](https://prismjs.com/) 来进行语法高亮;
|
||||
- `interface.qss`: 这是一个[**Qt样式文件**](http://doc.qt.io/qt-5/stylesheet-reference.html)，定义了所有窗口部件的外观；该文件会使用`palette.json`里面定义的颜色；
|
||||
- `text-editor.theme`: 文本编辑器（以及Markdown编辑器）的主题文件；
|
||||
- `web.css`: Markdown阅读模式的样式文件；
|
||||
- `highlight.css`: Markdown阅读模式的代码块语法高亮样式文件；VNote在阅读模式使用[Prism](https://prismjs.com/)来进行语法高亮;
|
||||
|
||||
## 示例
|
||||
### 自定义字体
|
||||
#### 阅读模式
|
||||
**阅读模式**的字体定义在文件 `web.css` 的 `font-family` 和 `font-size` 中。
|
||||
**阅读模式**的字体定义在文件`web.css`的`font-family`和`font-size`中。
|
||||
|
||||
正文的样式：
|
||||
|
||||
@ -61,7 +61,7 @@ pre code {
|
||||
}
|
||||
```
|
||||
|
||||
对于有语法高亮的代码块，其样式定义在文件 `highlight.css` 中：
|
||||
对于有语法高亮的代码块，其样式定义在文件`highlight.css`中：
|
||||
|
||||
```css
|
||||
code[class*="language-"],
|
||||
@ -88,8 +88,8 @@ pre[class*="language-"] {
|
||||
}
|
||||
```
|
||||
|
||||
#### 文本编辑器和 Markdown 编辑器
|
||||
文本编辑器和 Markdown 编辑器的字体定义在 `text-editor.theme` 文件。
|
||||
#### 文本编辑器和Markdown编辑器
|
||||
文本编辑器和Markdown编辑器的字体定义在`text-editor.theme`文件。
|
||||
|
||||
文本编辑器：
|
||||
|
||||
@ -109,7 +109,7 @@ pre[class*="language-"] {
|
||||
}
|
||||
```
|
||||
|
||||
Markdown 编辑器：
|
||||
Markdown编辑器：
|
||||
|
||||
```json
|
||||
{
|
||||
@ -125,4 +125,4 @@ Markdown 编辑器：
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
@ -9,11 +9,11 @@
|
||||
|
||||
## 配置
|
||||
### GitHub/码云
|
||||
码云和 GitHub 有相似的流程。这里我们以 GitHub 为例。
|
||||
码云和GitHub有相似的流程。这里我们以GitHub为例。
|
||||
|
||||
1. 前往 GitHub 的 `Settings`，`Developer settings`，然后生成一个新的 `Personal access tokens`。
|
||||
1. 前往GitHub的`Settings`，`Developer settings`，然后生成一个新的`Personal access tokens`。
|
||||
|
||||
2. 为令牌选择 `repo` 范围，然后生成该令牌。复制。
|
||||
2. 为令牌选择`repo`范围，然后生成该令牌。复制。
|
||||
|
||||
3. 新建一个用于保存图片的**公开**仓库。记住选择生成默认的 `README` 文件，这样会创建第一个提交。
|
||||
4. 在 VNote 里面新建一个图床，输入**个人令牌**，**用户名**和**仓库名**。
|
||||
3. 新建一个用于保存图片的**公开**仓库。记住选择生成默认的`README`文件，这样会创建第一个提交。
|
||||
4. 在VNote里面新建一个图床，输入**个人令牌**，**用户名**和**仓库名**。
|
||||
|
||||
@ -1,37 +1,37 @@
|
||||
# 导出
|
||||
VNote 支持将笔记导出为多种格式，如 `Markdown`， `PDF` 和 `HTML`。 通过使用 [Pandoc](https://pandoc.org/)，可以支持更多目标格式。
|
||||
VNote支持将笔记导出为多种格式，如`Markdown`，`PDF`和`HTML`。通过使用[Pandoc](https://pandoc.org/)，可以支持更多目标格式。
|
||||
|
||||
## 通用设置
|
||||
|
||||
|
||||
* VNote 支持导出当前笔记、当前文件夹的笔记以及当前笔记本的所有笔记。
|
||||
* 目前格式包括 `Markdown`, `HTMl`, `PDF` 和 `自定义`。
|
||||
* VNote 支持指定导出时使用不同的渲染样式。
|
||||
* VNote支持导出当前笔记、当前文件夹的笔记以及当前笔记本的所有笔记。
|
||||
* 目前格式包括`Markdown`,`HTMl`,`PDF`和`自定义`。
|
||||
* VNote支持指定导出时使用不同的渲染样式。
|
||||
|
||||
## Markdown
|
||||
VNote 会将文件导出为 `Markdown` 格式到一个单独的目录，其中包含对应的图片和附件。
|
||||
VNote会将文件导出为`Markdown`格式到一个单独的目录，其中包含对应的图片和附件。
|
||||
|
||||
## HTML
|
||||
|
||||
|
||||
VNote 允许将文件导出为一个单独的 `HTML` 页面，其中会嵌入用到的样式和图片，方便分享。
|
||||
VNote允许将文件导出为一个单独的`HTML`页面，其中会嵌入用到的样式和图片，方便分享。
|
||||
|
||||
## PDF
|
||||
|
||||
|
||||
VNote 支持直接导出为 `PDF` 或者通过 `wkhtmltopdf` 工具进行导出。后者支持大纲。
|
||||
VNote支持直接导出为`PDF`或者通过`wkhtmltopdf`工具进行导出。后者支持大纲。
|
||||
|
||||
`多合一` 选项运行将多个文件导出并合并为一个目标文件。
|
||||
`多合一`选项运行将多个文件导出并合并为一个目标文件。
|
||||
|
||||
## 自定义
|
||||
|
||||
|
||||
VNote 允许使用自定义的命令来导出文件。一个常用的工具是 `pandoc`。请参考该工具的文档以获取详细用法。我们甚至可以使用脚本来处理笔记。
|
||||
VNote允许使用自定义的命令来导出文件。一个常用的工具是`pandoc`。请参考该工具的文档以获取详细用法。我们甚至可以使用脚本来处理笔记。
|
||||
|
||||
在 Windows 上，以下命令通过使用 `pandoc` 可以将文件导出为几乎任意格式。只需要修改 `目标文件后缀` 为 `docx` 或者 `epub` 等即可。
|
||||
在Windows上，以下命令通过使用`pandoc`可以将文件导出为几乎任意格式。只需要修改`目标文件后缀`为`docx`或者`epub`等即可。
|
||||
|
||||
```
|
||||
"c:\your\path\to\the\downloaded\executable\pandoc.exe" --resource-path=.;%2 --css=%3 --css=%4 -s -o %5 %1
|
||||
```
|
||||
|
||||
在非 Windows 平台上，请将分隔符 `;` 改为 `:`。
|
||||
在非Windows平台上，请将分隔符`;`改为`:`。
|
||||
|
||||
@ -1,30 +1,30 @@
|
||||
# 常见问题
|
||||
## 如何指定自定义 MathJax 脚本？
|
||||
VNote 使用 MathJax 3 渲染数学公式。要指定使用的 MathJax 脚本，请执行以下步骤：
|
||||
## 如何指定自定义MathJax脚本？
|
||||
VNote使用MathJax 3渲染数学公式。要指定使用的MathJax脚本，请执行以下步骤：
|
||||
|
||||
1. 打开默认配置文件夹，复制其中的 `web/js/mathjax.js` 到用户配置文件夹，保留路径 `web/js/mathjax.js`，然后就可以修改该 `mathjax.js` 文件了。这样，VNote 就会使用复制后的文件，而不是默认的文件。
|
||||
2. 编辑 `mathjax.js` 文件。使用的 MathJax 脚本由这一行指定：
|
||||
1. 打开默认配置文件夹，复制其中的`web/js/mathjax.js`到用户配置文件夹，保留路径`web/js/mathjax.js`，然后就可以修改该`mathjax.js`文件了。这样，VNote就会使用复制后的文件，而不是默认的文件。
|
||||
2. 编辑`mathjax.js`文件。使用的MathJax脚本由这一行指定：
|
||||
```js
|
||||
this.mathJaxScript = 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js';
|
||||
```
|
||||
|
||||
您可以[下载 MathJax](https://docs.mathjax.org/en/latest/web/hosting.html) 并指定一个本地的 MathJax 脚本：
|
||||
您可以[下载MathJax](https://docs.mathjax.org/en/latest/web/hosting.html)并指定一个本地的MathJax脚本：
|
||||
|
||||
```js
|
||||
this.mathJaxScript = 'file://c:/Users/foo/mathjax/tex-svg.js';
|
||||
```
|
||||
|
||||
## 更新后启动失败
|
||||
一般是由于跨多个版本号进行更新引起的。打开用户配置文件夹，并删除其中的 `vnotex.json` 即可。
|
||||
一般是由于跨多个版本号进行更新引起的。打开用户配置文件夹，并删除其中的`vnotex.json`即可。
|
||||
|
||||
## 界面无响应
|
||||
## 编辑模式中光标不可见
|
||||
## 打开一个笔记时程序崩溃
|
||||
当出现在 Windows 上时，以上三个问题都可能是因为显卡驱动的原因。可以逐步尝试以下3个步骤：
|
||||
当出现在Windows上时，以上三个问题都可能是因为显卡驱动的原因。可以逐步尝试以下3个步骤：
|
||||
|
||||
1. 尝试更新显卡驱动；
|
||||
2. 尝试将 VNote 指定使用集成显卡；
|
||||
3. 尝试在`设置`对话框里面指定 `OpenGL` 的值，逐个值进行尝试。
|
||||
2. 尝试将VNote指定使用集成显卡；
|
||||
3. 尝试在`设置`对话框里面指定`OpenGL`的值，逐个值进行尝试。
|
||||
|
||||
|
||||
每一步操作都需要重启 VNote 来验证是否有用。
|
||||
每一步操作都需要重启VNote来验证是否有用。
|
||||
|
||||
@ -1,27 +1,27 @@
|
||||
# 快速上手
|
||||
VNote 适用于 **Linux** ， **Windows** 和 **macOS** 操作系统。您可以从[下载](https://github.com/vnotex/vnote#downloads)页面获取独立软件包。
|
||||
VNote适用于**Linux**，**Windows**和**macOS**操作系统。您可以从[下载](https://github.com/vnotex/vnote#downloads)页面获取独立软件包。
|
||||
|
||||
建议下载并使用 VNote 的**稳定版本** 。如果您更喜欢使用 VNote 的一些最新功能，可以尝试使用从 `master` 分支产生的最新版本。
|
||||
建议下载并使用VNote的**稳定版本**。如果您更喜欢使用VNote的一些最新功能，可以尝试使用从`master`分支产生的最新版本。
|
||||
|
||||
除了独立的安装包之外，一些包管理者可能已经打包和分发 VNote ，例如 *AUR* 和 *homebrew cask* 。
|
||||
除了独立的安装包之外，一些包管理者可能已经打包和分发VNote，例如*AUR*和*homebrew cask*。
|
||||
|
||||
## 主界面
|
||||
这是 VNote 主界面的截图。
|
||||
这是VNote主界面的截图。
|
||||
|
||||
|
||||
|
||||
### 笔记本，文件夹和笔记
|
||||
VNote使用**笔记本**、**文件夹**和**笔记**层次结构进行笔记管理。左侧面板用于浏览笔记本，文件夹和笔记。
|
||||
|
||||
笔记本对应于文件系统中的目录。您应该选择一个空目录作为您的 *笔记本根文件夹* 。此笔记本的所有内容都将被存储在笔记本根文件夹中。
|
||||
笔记本对应于文件系统中的目录。您应该选择一个空目录作为您的*笔记本根文件夹*。此笔记本的所有内容都将被存储在笔记本根文件夹中。
|
||||
|
||||
一旦您有了一个笔记本，就可以在这个笔记本中创建文件夹。VNote 支持无限级别的文件夹。
|
||||
一旦您有了一个笔记本，就可以在这个笔记本中创建文件夹。VNote支持无限级别的文件夹。
|
||||
|
||||
### 内容区域
|
||||
占据大部分空间的中间区域是**内容区域** ，用于阅读和编辑笔记。VNote 支持通过选项卡打开多个笔记。
|
||||
占据大部分空间的中间区域是**内容区域**，用于阅读和编辑笔记。VNote支持通过选项卡打开多个笔记。
|
||||
|
||||
### 停靠部件
|
||||
在左侧，有多个停靠部件，包括**导航** ， **大纲** ， **搜索**等。它们可以被自由拖拽并放置到主窗口的上下左右部分。
|
||||
在左侧，有多个停靠部件，包括**导航**，**大纲**，**搜索**等。它们可以被自由拖拽并放置到主窗口的上下左右部分。
|
||||
|
||||
### 准备开始
|
||||
这就是 VNote 了！现在，您可以在 VNote 中阅读、编辑和管理您的笔记了！
|
||||
这就是VNote了！现在，您可以在VNote中阅读、编辑和管理您的笔记了！
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
# 模板
|
||||
VNote 支持基于模板创建笔记。
|
||||
VNote支持基于模板创建笔记。
|
||||
|
||||
创建笔记时，您可以在对话框中选择一个模板。
|
||||
|
||||
|
||||
|
||||
VNote 将模板文件保存在文件夹 `templates` 中。一个文件对应一个模板。
|
||||
VNote将模板文件保存在文件夹`templates`中。一个文件对应一个模板。
|
||||
|
||||
可以通过系统的文件浏览器直接添加或者删除模板文件。
|
||||
|
||||
@ -16,9 +16,9 @@ VNote 将模板文件保存在文件夹 `templates` 中。一个文件对应一
|
||||
This is a template using **Snippet** to insert note name as the title automatically.
|
||||
```
|
||||
|
||||
`%no%` 是一个内建片段，会被识别为当前笔记名字（不带后缀）。 因此，如果笔记命名为 `week report.md` ，则新笔记内容将如下：
|
||||
`%no%`是一个内建片段，会被识别为当前笔记名字（不带后缀）。因此，如果笔记命名为`week report.md`，则新笔记内容将如下：
|
||||
|
||||
```md
|
||||
# week report
|
||||
This is a template using **Snippet** to insert note name as the title automatically.
|
||||
```
|
||||
```
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# 欢迎使用 VNote 文档
|
||||
# 欢迎使用VNote文档
|
||||
|
||||
|
||||
VNote 是一个舒适的笔记平台，始于2016年。VNote 是开源的，源代码托管在 [GitHub](https://github.com/vnotex/vnote)。
|
||||
VNote是一个舒适的笔记平台，始于2016年。VNote是开源的，源代码托管在[GitHub](https://github.com/vnotex/vnote)。
|
||||
|
||||
@ -2,33 +2,33 @@
|
||||
片段旨在方便重复输入一些内容。
|
||||
|
||||
## 片段管理
|
||||
每个用户自定义的片段都会对应一个 `json` 文件。VNote 自带内建的片段，例如输入当前日期的片段。内建片段是只读的，并且在名字后面会带有一个 `*` 后缀。
|
||||
每个用户自定义的片段都会对应一个`json`文件。VNote自带内建的片段，例如输入当前日期的片段。内建片段是只读的，并且在名字后面会带有一个`*`后缀。
|
||||
|
||||
|
||||
|
||||
## 定义一个片段
|
||||
|
||||
|
||||
- 片段名称： 一个片段的标识符，用于搜索一个片段。
|
||||
- 片段名称：一个片段的标识符，用于搜索一个片段。
|
||||
- 快捷键：可以为片段指定一个两位数的快捷键以便快速输入。
|
||||
- 光标标记：插入片段后，VNote 使用光标标记表示光标的位置。应该只在内容中出现一次。
|
||||
- 选择标记：VNote 使用选择标记来标记插入应用片段前所选文本的位置。选择标记可以在内容中出现多次。插入片段后，所有选择标记都将替换为所选文本。
|
||||
- 光标标记：插入片段后，VNote使用光标标记表示光标的位置。应该只在内容中出现一次。
|
||||
- 选择标记：VNote使用选择标记来标记插入应用片段前所选文本的位置。选择标记可以在内容中出现多次。插入片段后，所有选择标记都将替换为所选文本。
|
||||
|
||||
## 应用片段
|
||||
### 片段面板
|
||||
将编辑器光标放在合适的位置，然后双击片段面板中的片段以应用一个片段。
|
||||
|
||||
### 快捷键
|
||||
编辑器中，按 `Ctrl+G, I` 可以唤出一个包含所有片段的面板。如下图，此时可以直接输入 `00` 来应用片段 `My First Snippet`。或者输入关键字 `my` 来按名字搜索片段，然后按回车来应用第一个片段。
|
||||
编辑器中，按`Ctrl+G, I`可以唤出一个包含所有片段的面板。如下图，此时可以直接输入`00`来应用片段`My First Snippet`。或者输入关键字`my`来按名字搜索片段，然后按回车来应用第一个片段。
|
||||
|
||||
可以按 `Tab` 来将焦点转移到片段列表中，此时可以使用 `Ctrl+H/J/K/L` 来遍历这些项目并按回车应用当前片段。
|
||||
可以按`Tab`来将焦点转移到片段列表中，此时可以使用`Ctrl+H/J/K/L`来遍历这些项目并按回车应用当前片段。
|
||||
|
||||
|
||||
|
||||
### 符号
|
||||
另一个应用片段的简单方法是在编辑器中直接输入 `%片段名字%` 然后按 `Ctrl+G, I` 来将该符号翻译到对应的片段 `片段名字`。
|
||||
另一个应用片段的简单方法是在编辑器中直接输入`%片段名字%`然后按`Ctrl+G, I`来将该符号翻译到对应的片段`片段名字`。
|
||||
|
||||
此外，VNote 中很多行编辑框是支持通过符号来应用片段的，例如：
|
||||
此外，VNote中很多行编辑框是支持通过符号来应用片段的，例如：
|
||||
|
||||
* 新建笔记对话框；
|
||||
* 新建笔记本对话框；
|
||||
|
||||
@ -1,26 +1,26 @@
|
||||
# 笔记管理
|
||||
VNote 采用**笔记本-文件夹-笔记**的层次结构进行笔记管理。一个笔记本对应于文件系统中的一个目录，称为**笔记本根文件夹** 。笔记本中的文件夹对应于笔记本根文件夹中的目录。文件夹中的笔记对应于该目录中的文件。
|
||||
VNote采用**笔记本-文件夹-笔记**的层次结构进行笔记管理。一个笔记本对应于文件系统中的一个目录，称为**笔记本根文件夹**。笔记本中的文件夹对应于笔记本根文件夹中的目录。文件夹中的笔记对应于该目录中的文件。
|
||||
|
||||
VNote 可能会使用一些额外的索引文件来跟踪一个笔记本内的所有笔记，所以推荐通过 VNote 来管理您的笔记。
|
||||
VNote可能会使用一些额外的索引文件来跟踪一个笔记本内的所有笔记，所以推荐通过VNote来管理您的笔记。
|
||||
|
||||
## 笔记本
|
||||
VNote 中，笔记本是一个独立的、自解释的容器。一个笔记本是位于文件系统中的一个**笔记本根文件夹** 。该根文件夹包括该笔记本的所有笔记和配置文件。
|
||||
VNote中，笔记本是一个独立的、自解释的容器。一个笔记本是位于文件系统中的一个**笔记本根文件夹**。该根文件夹包括该笔记本的所有笔记和配置文件。
|
||||
|
||||
### 创建一个笔记本
|
||||
您可以从一个空白的笔记本根文件夹直接创建一个笔记本。
|
||||
|
||||
如果在使用 VNote 前已经拥有很多 Markdown 文件，您可以通过**从文件夹创建笔记本**来基于已有的目录构建一个笔记本。
|
||||
如果在使用VNote前已经拥有很多Markdown文件，您可以通过**从文件夹创建笔记本**来基于已有的目录构建一个笔记本。
|
||||
|
||||
### 迁移和导入笔记本
|
||||
一个笔记本是文件系统中的一个独立目录，因此您只需复制或同步*笔记本根文件夹*即可迁移一个笔记本。
|
||||
|
||||
您可以在 VNote 里面选定其*笔记本根文件夹*来导入一个已有的笔记本。VNote 会尝试读取配置文件来复原一个笔记本。
|
||||
您可以在VNote里面选定其*笔记本根文件夹*来导入一个已有的笔记本。VNote会尝试读取配置文件来复原一个笔记本。
|
||||
|
||||
|
||||
|
||||
结合这些操作，您可以在使用第三方服务（如 Dropbox 和 OneDrive）同步的目录中创建笔记本，然后在另一台计算机中，您可以将该目录作为笔记本导入到 VNote。这样，您可以使用 VNote 编辑和管理您的笔记，而这些笔记将由其他受信任的服务在家和公司之间进行同步。
|
||||
结合这些操作，您可以在使用第三方服务（如Dropbox和OneDrive）同步的目录中创建笔记本，然后在另一台计算机中，您可以将该目录作为笔记本导入到VNote。这样，您可以使用VNote编辑和管理您的笔记，而这些笔记将由其他受信任的服务在家和公司之间进行同步。
|
||||
|
||||
### 导入文件和文件夹
|
||||
您可以导入外部文件和文件夹到已有的笔记本中。
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
# 配置
|
||||
VNote 中有三种主要配置。
|
||||
VNote中有三种主要配置。
|
||||
|
||||
* 默认配置；
|
||||
应用程序的默认配置。用户无需修改这些文件，因为它们会在版本更新的时候被强制覆写。要自定义配置，您可以拷贝这些文件到**用户配置**文件夹中并修改。
|
||||
* 用户配置；
|
||||
用户配置，会覆盖默认配置。
|
||||
* 会话配置；
|
||||
关于会话的配置，例如笔记本列表、主窗口的形状大小等等。它是一个位于*用户配置*文件夹中的名为 `session.json` 的文件。如果需要修改该文件，您应该首先关闭 VNote，因为 VNote 会在关闭时写入该文件。
|
||||
关于会话的配置，例如笔记本列表、主窗口的形状大小等等。它是一个位于*用户配置*文件夹中的名为`session.json`的文件。如果需要修改该文件，您应该首先关闭VNote，因为VNote会在关闭时写入该文件。
|
||||
|
||||
|
||||
## 配置的组成
|
||||
@ -22,12 +22,12 @@ VNote 中有三种主要配置。
|
||||
└── vnotex.json (configuration file)
|
||||
```
|
||||
|
||||
对于 `vnotex.json` 文件，请参考默认配置文件夹中的文件，其中包含有对每个域的注释。
|
||||
对于`vnotex.json`文件，请参考默认配置文件夹中的文件，其中包含有对每个域的注释。
|
||||
|
||||
## 便携化
|
||||
用户可能希望配置文件能跟随 VNote 的可执行文件一起。可以参考以下步骤来迁移配置文件夹：
|
||||
用户可能希望配置文件能跟随VNote的可执行文件一起。可以参考以下步骤来迁移配置文件夹：
|
||||
|
||||
1. 关闭 VNote；
|
||||
2. 复制默认配置文件夹 `VNote` 到可执行文件（如 `vnote.exe` ）所在目录中，并重命名为 `vnotex_files` ；
|
||||
3. 复制用户配置文件夹 `VNote` 到可执行文件所在目录中，并重命名为 `user_files` ；
|
||||
1. 关闭VNote；
|
||||
2. 复制默认配置文件夹`VNote`到可执行文件（如`vnote.exe`）所在目录中，并重命名为`vnotex_files`；
|
||||
3. 复制用户配置文件夹`VNote`到可执行文件所在目录中，并重命名为`user_files`；
|
||||
|
||||
|
||||
@ -5,6 +5,9 @@
|
||||
|
||||
:::
|
||||
|
||||
国内的用户可以尝试在[天翼云盘](https://cloud.189.cn/t/Av67NvmEJVBv)下载 VNote 的最新发行版本。
|
||||
`master` 分支的最新[持续构建](https://github.com/vnotex/vnote/releases/tag/continuous-build)。
|
||||
|
||||
`master` 分支的最新 [持续构建](https://github.com/vnotex/vnote/releases/tag/continuous-build) 。
|
||||
国内的用户可以尝试以下下载：
|
||||
|
||||
* [天翼云盘](https://cloud.189.cn/t/Av67NvmEJVBv)
|
||||
* [百度云盘](https://pan.baidu.com/s/1Fou1flmBsQUQ8Qs9V_M6Aw) 提取码`code`
|
||||
|
||||
@ -3,20 +3,20 @@
|
||||
|
||||
::: alert-success
|
||||
|
||||
VNote 3.7.0 已发布！ 看看都有[哪些更新](https://github.com/vnotex/vnote/releases) ！
|
||||
VNote 3.10.1已发布！ 看看都有[哪些更新](https://github.com/vnotex/vnote/releases) ！
|
||||
|
||||
观看[展示录屏](https://www.bilibili.com/video/av77455284) ！
|
||||
|
||||
:::
|
||||
|
||||
- 参与 VNote [GitHub](https://github.com/vnotex/vnote)
|
||||
- 聊聊 VNote [Slack](https://join.slack.com/t/vnote/shared_invite/enQtNDg2MzY0NDg3NzI4LTVhMzBlOTY0YzVhMmQyMTFmZDdhY2M3MDQxYTBjOTA2Y2IxOGRiZjg2NzdhMjkzYmUyY2VkMWJlZTNhMTQyODU)
|
||||
- 参与VNote [GitHub](https://github.com/vnotex/vnote)
|
||||
- 聊聊VNote [Slack](https://join.slack.com/t/vnote/shared_invite/enQtNDg2MzY0NDg3NzI4LTVhMzBlOTY0YzVhMmQyMTFmZDdhY2M3MDQxYTBjOTA2Y2IxOGRiZjg2NzdhMjkzYmUyY2VkMWJlZTNhMTQyODU)
|
||||
- [Telegram](https://t.me/vnotex)
|
||||
|
||||
## 开源和自由
|
||||
- 遵从 [GNU LGPLv3](https://opensource.org/licenses/LGPL-3.0) 开源协议
|
||||
- 由 Qt 和 C++ 提供强劲性能
|
||||
- 支持主流操作系统 Linux，Windows，和 macOS
|
||||
- 遵从[GNU LGPLv3](https://opensource.org/licenses/LGPL-3.0)开源协议
|
||||
- 由Qt和C++提供强劲性能
|
||||
- 支持主流操作系统Linux，Windows，和macOS
|
||||
|
||||
|
||||
|
||||
@ -41,8 +41,8 @@ VNote 3.7.0 已发布！ 看看都有[哪些更新](https://github.com/vnotex/vn
|
||||
|
||||
|
||||
|
||||
## 舒适的 Markdown 体验
|
||||
- 最小化 Markdown 阅读和书写的鸿沟
|
||||
## 舒适的Markdown体验
|
||||
- 最小化Markdown阅读和书写的鸿沟
|
||||
- 语法高亮和原地预览
|
||||
- 高效的图片管理
|
||||
- 交互式的大纲
|
||||
@ -57,7 +57,7 @@ VNote 3.7.0 已发布！ 看看都有[哪些更新](https://github.com/vnotex/vn
|
||||
|
||||
|
||||
## 程序员为程序员优化打造
|
||||
- Vi 模式和 Vi 式导航
|
||||
- Vi模式和Vi式导航
|
||||
- 编辑器行号
|
||||
- 多标签页
|
||||
- 窗口分割
|
||||
@ -68,6 +68,6 @@ VNote 3.7.0 已发布！ 看看都有[哪些更新](https://github.com/vnotex/vn
|
||||
|
||||
::: alert-success
|
||||
|
||||
[**下载 VNote**](downloads.md)，开始 Markdown 之旅！
|
||||
[**下载VNote**](downloads.md)，开始Markdown之旅！
|
||||
|
||||
:::
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user