在很多地方,尤其是在github上的项目中,常常能看到README.md这样的文件。以md为后缀名(不是骂人的话!)的文件即是markdown格式,一种通过少量标记来给本来无格式的文本一些格式(放大,斜体,加粗等)的方法。 虽然markdown是一种标记语言,但其实所要记的东西一点都不多,毕竟也只有那么几种标记,然而却足以应付生活中的绝大部分需求,因此被广泛采用。项目中的文档基本就是通过markdown来书写的,而如果你能够看到源码的话,便会发现我的这几篇博客也使用了markdown。
下面就来列举markdown中的一些常用标记,往往和HTML中的标签相对应。
行首以#开头并在其后一个空格,那么这一行就形成了一个标题,取决于#的个数标题的级别也不同,#的数量从一个到六个分别对应于HTML的h1到h6标签
像这样在文字两侧各加上一个星号即可
在文字两侧各加上两个星号
在文字两侧各加上两个波浪号
像这样行首以>开头并加上一个空格
print("helloworld")
c++#include <iostream>
int main(){
std::cout<<"Nice to meet you!";
return 0;
}
用方括号包围文本,圆括号包围链接 Markdown官方教程
上面或下面都可以
下面是以上的源码,方便与浏览器上显示的内容相照应:
markdown## 标题
行首以#开头并在其后一个空格,那么这一行就形成了一个标题,取决于#的个数标题的级别也不同,#的数量从一个到六个分别对应于HTML的h1到h6标签
## 列表
+ 在行首用“ + ”、“ - ”、“ * ”中的任意一个加上一个空格即可,这一行便会成为由一个圆点开头的一行无序列表
+ 与无序列表相似,开头用数字加上“ . ”再空一行,这一行便是由数字排序的有序列表。
## 斜体
*像这样在文字两侧各加上一个星号即可*
## 粗体
**在文字两侧各加上两个星号**
## 删除线
~~在文字两侧各加上两个波浪号~~
## 引用
> 像这样行首以>开头并加上一个空格
## 代码
1. 文字两侧各加上一个反引号是一行代码
`print("helloworld")`
2. 文字两侧各加上三个反引号就是代码块
```c++
#include <iostream>
int main(){
std::cout<<"Nice to meet you!";
return 0;
}
```
3. 代码格式识别语言类型后有时可以有语法高亮的效果
## 链接
用方括号包围文本,圆括号包围链接
[Markdown官方教程](https://markdown.com.cn/)
## 分割线
---
上面或下面都可以
***
如此这般,简单的几个标记就可以给本来平平淡淡的文本增添许多色彩。而这也是贯穿Markdown的主旨:精美且简约。