markdown小记

时间:2022-09-20 21:55:06

一直听说用markdown写文档比较符合程序员的逼格,没事就倒腾了下,附上近期整理的精华,留自己以方便查阅。

1、常用指令

单个回车
视为空格。 连续回车 才能分段。 行尾加两个空格,这里->
即可段内换行。 *这些文字显示为斜体* **这些文字显示为粗体**

效果:

单个回车

视为空格。

连续回车

才能分段。

行尾加两个空格,这里->

即可段内换行。

这些文字显示为斜体

这些文字显示为粗体


2、代码显示

行的开头空4个空格,表示程序代码,例如:

C#:

    //这里显示一些代码,在正文显示中会自动识别语言,进行代码染色,这是一段C#代码
public class Blog
{
public int Id { get; set; }
public string Subject { get; set; }
}

效果显示

C#:

//这里显示一些代码,在正文显示中会自动识别语言,进行代码染色,这是一段C#代码
public class Blog
{
public int Id { get; set; }
public string Subject { get; set; }
}

3、常用标题设置

代码如下:

>表示引用文字内容。
#表示这是一级标题
##表示这是二级标题
###表示这是三级标题
……
###### 最小是六级标题
也可以这样表示大标题
=
这样表示小标题
-

效果如下:

表示引用文字内容。

表示这是一级标题

表示这是二级标题

表示这是三级标题

……

最小是六级标题

也可以这样表示大标题

这样表示小标题


4、常用列表显示

代码如下:

---
上面是一条分隔线 - 这是无序列表项目
- 这是无序列表项目
- 这是无序列表项目 两个列表之间不能相邻,否则会解释为嵌套的列表 1. 这是有序列表项目
2. 这是有序列表项目
3. 这是有序列表项目 下面这个是嵌套的列表 - 外层列表项目
+ 内层列表项目
+ 内层无序列表项目
+ 内层列表项目
- 外层列表项目

效果如下:


上面是一条分隔线

  • 这是无序列表项目
  • 这是无序列表项目
  • 这是无序列表项目

两个列表之间不能相邻,否则会解释为嵌套的列表

  1. 这是有序列表项目
  2. 这是有序列表项目
  3. 这是有序列表项目

下面这个是嵌套的列表(有点尴尬,这个在博客园上不知道为啥不能识别,但在其他模仿markdown的软件上可以)

  • 外层列表项目
  • 内层列表项目
  • 内层无序列表项目
  • 内层列表项目
  • 外层列表项目

5、超链接设置

代码如下:

直接把一个URL显示为超级连接:

也可以这样:[图灵社区](http://www.ituring.com.cn)

图像和链接非常类似,区别在开头加一个惊叹号: ![这是一个Logo图像](//bbsmax.ikafan.com/static/L3Byb3h5L2h0dHAvd3d3LnR1cmluZ2Jvb2suY29tL0NvbnRlbnQvaW1nL1R1cmluZy5HaWY=.jpg)

此外,还可以以索引方式把url都列在文章的最后,例如这样:

[图灵社区][1]
![图灵社区Logo][2] [1]:http://www.ituring.com.cn
[2]://bbsmax.ikafan.com/static/L3Byb3h5L2h0dHAvd3d3Lml0dXJpbmcuY29tLmNuL0NvbnRlbnQvaW1nL1R1cmluZy5HaWY=.jpg

效果如下:

直接把一个URL显示为超级连接:

也可以这样:图灵社区

图像和链接非常类似,区别在开头加一个惊叹号: markdown小记

此外,还可以以索引方式把url都列在文章的最后,例如这样:

图灵社区

markdown小记