做为一个半路出家,入行快四年的程序猿,写文档一直是一件让我很头疼的事。使用Word时候,须要考虑诸如标题、字号、格式、缩进等等一系列的东西,而要能熟练的使用这些,我以为不是三两天的时间能够搞定的。由于以上缘由(主要是由于懒),一直很抵触写文档这件事。html
前段时间由于工做须要,到了不起不写文档的时候了。一想到要将项目相关的文档全都翻译成中文,写成文档,当时以为天都要塌了。所幸山重水复疑无路,柳暗花明又一村。在翻译文档的时候,发现人家项目的说明文档全是“.md”后缀的。这个后缀的文档,以前见过不少,知道是Markdown文档。既然别人的官方文档是用Markdown写的,为了尽量的保证原汁原味,那咱也用“.md”写吧。python
如下是我的在使用Markdown时的一些总结。我使用的编辑器是微软的VScode。在这里不得不夸一句,“VScode真好用!!!”。ios
使用vscode写md文档时,我主要用到了两个插件:Markdown Preview Enhanced 和 Markdown PDF。Markdown Preview Enhanced是用来预览文件的;Markdown PDF是用来将写好的文档转换成其它格式,支持转化的文件格式有:pdf、html、png和jpeg四种格式。markdown
Markdown是一种轻量级的标记语言,语法十分简单,经常使用的符号也不超过十个。因此Markdown的学习成本不会很高,并且一旦熟悉了语法,那将是一劳永逸的事。编辑器
使用Markdown时,你只须要专一于你的文字内容而不须要分出过多的精力来组织文档的排版;并且能够轻松导出为PDF或HTML。学习
Markdown的哲学在于“Markdown is intended to be as easy-to-read and easy-to-write as is feasible”。插件
经常使用的语法以下表:翻译
输出效果 | 写法 |
---|---|
粗体 | **text** |
斜体 | *text* |
连接 | [title](http://) |
大段引用 | ``` content``` |
小段引用 | > content |
一级标题 | # head |
二级标题 | ## head |
... | ... |
六级标题 | ###### head |
当须要换行时,在行尾输入两个空格而后回车code
只需在两段文字之间空一行便可htm
使用“*”,与文字间隔一个空格。
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; }
分割线的话,使用***
就好。
上边是分割线。