Markdown使用小结

Posted 2021-12-02 lianshuiwuyi

写在之前

作为一个半路出家，入行快四年的程序猿，写文档一直是一件让我很头疼的事。使用Word时候，需要考虑诸如标题、字号、格式、缩进等等一系列的东西，而要能熟练的使用这些，我觉得不是三两天的时间可以搞定的。因为以上原因（主要是因为懒），一直很抵触写文档这件事。

前段时间因为工作需要，到了不得不写文档的时候了。一想到要将项目相关的文档全都翻译成中文，写成文档，当时觉得天都要塌了。所幸山重水复疑无路，柳暗花明又一村。在翻译文档的时候，发现人家项目的说明文档全是“.md”后缀的。这个后缀的文档，之前见过很多，知道是Markdown文档。既然别人的官方文档是用Markdown写的，为了尽可能的保证原汁原味，那咱也用“.md”写吧。

以下是个人在使用Markdown时的一些总结。我使用的编辑器是微软的VScode。在这里不得不夸一句，“VScode真好用！！！”。

使用vscode写md文档时，我主要用到了两个插件：Markdown Preview Enhanced 和 Markdown PDF。Markdown Preview Enhanced是用来预览文件的；Markdown PDF是用来将写好的文档转换成其它格式，支持转化的文件格式有：pdf、html、png和jpeg四种格式。

介绍

Markdown是一种轻量级的标记语言，语法十分简单，常用的符号也不超过十个。所以Markdown的学习成本不会很高，而且一旦熟悉了语法，那将是一劳永逸的事。

使用Markdown时，你只需要专注于你的文字内容而不需要分出过多的精力来组织文档的排版；而且可以轻松导出为PDF或HTML。

Markdown的哲学在于“Markdown is intended to be as easy-to-read and easy-to-write as is feasible”。

Markdown语法规则

常用的语法如下表：

输出效果	写法
粗体	**text**
斜体	*text*
链接	[title](http://)
大段引用	``` content```
小段引用	> content
一级标题	# head
二级标题	## head
...	...
六级标题	###### head

换行

当需要换行时，在行尾输入两个空格然后回车

段落

只需在两段文字之间空一行即可

列表

使用“*”，与文字间隔一个空格。

表格

Markdown的表格比较麻烦，写法如下：

|tables|col1|col2|
|---|:---:|---:|
|col1|col2|col3|
|content|hello world|Markdown|

显示如下：

tables	col1	col2
col1	col2	col3
content	hello world	Markdown

代码框

代码框中可以使用tab进行缩进。

    print()

#include <iostream>

int main(int argc,char* argv[])
{
    std::cout<<"hello world"<<std::endl;
    return 0;
}

分割线

分割线的话，使用***就好。

---

上边是分割线。