MacDown,优雅的文档编写方式

  对于程序员来说,写文档也是在代码外的一项技能。能够用代码的方式进行文档的编写我觉得是相当不错的行为。相信我,当你熟悉使用Macdown之后你会喜欢上这种文档书写方式。
  下面我将说下我在使用MacDown当中用到的语法:

  1. 在中文书写时我们通常习惯段首缩进两个字,但是使用markdown编辑时我们手打空格缩进是不起效果的,因此我们需要通过使用HTML中的空格实体来帮助我们实现缩进效果。
    一个汉字占两个空格大小,所以使用四个空格就可以达到首行缩进两个汉字的效果。有如下几种方法:
  • 一个空格大小的表示:,此时只要在相应需要缩进的段落前加上 4个 如上的标记即可,注意要带上分号
  • 两个空格的大小表示:,同理,使用2个即可缩进2个汉字,推荐使用该方式
  1. 粗体与斜体
    用 ** 包裹的为粗体内容,用 * 包裹的为斜体内容。
    粗体文字 **粗体文字**
    斜体文字 *斜体文字*
    加粗斜体***加粗斜体***
    3.标题
    MacDown的标题分为一级到六级,其写法如下,建议 # 与 标题 之间加上空格,此为标准写法。

title

title

title

title

title
title
#title

##title

###title

####title

#####title

######title
  1. 列表
    列表分为无序列表和有序列表,无序列表在文字前加 * 或 - 即可,有序列表需要在文字前加上 1. 2. ... ,注意符号和内容之间的空格。

无序列表

  • 无序列表
    • 无序列表
  • 无序列表
  • 无序列表

有序列表

  1. 有序列表
    1.1 有序列表
  2. 有序列表
  3. 有序列表
###无序列表
* 无序列表
    * 无序列表
* 无序列表
* 无序列表

###有序列表
1. 有序列表
    1.1 有序列表
2. 有序列表
3. 有序列表
  1. 引用
    如果你需要引用格式的效果,只需在文字前面加上 > 符号。

这里是引用的内容
这里是引用的内容

>这里是引用的内容
>这里是引用的内容
  1. 图片与链接
    插入链接:[文字内容](链接地址)
    插入图片: [图片内容]()

  2. 表格

| 默认格式  | 左对齐 | 居中 | 右对齐 |
| --- | :--- | :---: | ---: |
| 默认格式表格内容  | 左对齐表格内容 | 居中表格内容 | 右对齐表格内容 |
| 默认格式表格内容  | 左对齐表格内容 | 居中表格内容 | 右对齐表格内容 |
默认格式 左对齐 居中 右对齐
默认格式表格内容 左对齐表格内容 居中表格内容 右对齐表格内容
默认格式表格内容 左对齐表格内容 居中表格内容 右对齐表格内容
  1. 代码块
    使用 ` 包裹代码,如需要插入代码块则需要 ``` 或 ~~~ 包裹代码块。
`这里是单句代码`

这里是单句代码

```这里是多行代码```(```请单独做为一行)
这里是多行代码
  1. 分割线
    使用 *** 或 --- 即可


参考链接:
MacDown 日常使用参考教程
markdown空格缩进以及HTML空格实体

你可能感兴趣的:(MacDown,优雅的文档编写方式)