常用的Markdown书写文档的常见示例。

标题例子(Headings Sample)¶

# 第一级标题

## 第二级标题

### 第三级标题

#### 第四级标题

##### 第五级标题

###### 第六级标题

块嵌套例子(Blockquote nesting Sample)¶

这是第一个块

这是第一个块的子块

列表例子(Lists Sample)¶

• 这是列表第一行
• 这是列表第二行
  • 这是子列表第一行
  • 这是子列表第二行

表数据例子(Data tables Sample)¶

第一列	第二列
第一行	第一行第一列数据
第二行	第二行第二列数据

链接例子(Links Sample)¶

Material是 MkDocs的一个主题。

MkDocs是一个开源的静态站点架构工具。

目录例子(Directory Sample)¶

一个目录结构的例子如下所示。

.
├─ mkdocs/
│  ├─ images/                            # 图片目录
│  ├─ index.md                           # 首页
│  ├─ markdown.md                        # markdown例子页
│  └─ CHANGELOG.md                       # CHANGELOG页
├─ .gitlab-ci.yml                        # CI/CD配置文件
├─ mkdocs.yml                            # MkDocs的配置文件
├─ README.md                             # 项目README

水平线例子(Horizontal rules Sample)¶

---

脚本例子(Script Sample)¶

下面是一个Shell的脚本例子。

$ echo $EDITOR
vim
$ pip install mkdocs-material

下面是一个yaml文件的脚本例子。

theme:
  name: 'material'