1. Vnote使用说明

2018-10-31

在说Vnote之前不得不提到Markdown。从事软件工作的人，基本都很了解Markdown。毕竟Github默认就使用Markdwon来编写说明文档。但作为一名FPGA开发工程师，传说中的“硬件工程师中的软件工程师”，身边同事对开源软件知之甚少。

百度百科：Markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。

目前，我主要使用Markdwon来写笔记和写博客。而为什么我不用Word来写东西尼？并不是因为格式的问题，反而，我在Word中写作时，格式更好，速度更快。我使用Markdown的原因主要有以下几点：

可移植性好：Word写的内容要转发到CSDN这类博客，超级超级~麻烦，简直让人无法忍受
可插入代码块：Word插入代码块可以设置特定的格式，但无法高亮关键字，平时写笔记时，经常需要插入一些Python代码和Verilog代码，这方面更加友好
更丰富的功能：Markdown衍生产品中，支持各种图像渲染，目前，我使用WaveDrom来绘制Verilog的时序图，使用PlantUML来绘制状态图、软件时序图，使用Mermaid来绘制甘特图
便于版本管理：Markdown文件可以随代码一起再Git上管理，这一点Word无法做到。

目前，主流编辑器都支持Markdown（需安装插件）。其中，用得比较顺手的有：VS Code+Markdown Preview Enhenced,和Vnote。
其中，Markdown Preview Enhenced就Markdwon功能做的更好，而Vnote作为独立的笔记软件，对Markdwon笔记管理和一些使用习惯方面做了更多优化，更加适合于笔记场景应用。最使用的一点，Vnote支持图片的粘贴。

VNote 是一个受Vim启发的更懂程序员和Markdown的一个笔记软件。

下载地址：

1.1. PlantUML

1.1.1. Vnote中PlantUML配置

Vnote安装好后，plantUML和Mermaid并不能直接使用，需要进行一系列配置操作后方能使用。而官方网站并没有对这部分进行说明，其详细说明在官方微信中Vnote笔记中找到。在这里再转述一遍。
首先，在Graphviz官网下载Graphviz并安装。然后，在Vnote-文件-设置中，按如下设置，单击测试，显示成功即可。

其次，配置本地plantUML。在PlantUML官网下载plantuml.jar，放在本地目录中（需全英文路径），并设置系统环境变量。
注意：plantuml.jar的使用，还需要安装JRE环境。然后，在Vnote-文件-设置中，按如下设置，单击测试，显示成功即可。

1.1.2. 时序图

plantUML和Mermaid都可以渲染时序图，但个人认为plantUML的时序图渲染图像风格更好看。

mermaid渲染：

sequenceDiagramparticipant Aliceparticipant BobAlice->>John: Hello John, how are you?loop HealthcheckJohn->>John: Fight against hypochondriaendNote right of John: Rational thoughts <br/>prevail...John-->>Alice: Great!John->>Bob: How about you?Bob-->>John: Jolly good!