跳转至

如何写一篇课程文档

这是一篇示例文章,用来告诉你以后写文章时可以用哪些格式。你只需要打开任意一个 .md 文件,照着下面的写法修改即可。

1. 标题

一个 # 是文章大标题,两个 ## 是小标题,三个 ### 是更小的标题。

2. 文字格式

  • 加粗:用两个星号包住文字,像这样 **加粗**
  • 斜体:用一个星号包住文字,像这样 *斜体*
  • ~~删除线~~:用两个波浪线包住文字

3. 列表

无序列表用 - 开头(就像本页面的这些条目),有序列表用数字加点:

  1. 第一步
  2. 第二步
  3. 第三步

4. 链接和图片

链接写法:[链接文字](网址)

例如:打开必应搜索

图片写法:![图片说明](图片地址)

5. 代码块

引用命令或代码时,用三个反引号包起来:

pip install mkdocs-material

6. 引用

引用别人的话,用 > 开头:

知识就是力量。

7. 提示框

Material 主题支持好看的提示框:

提示

这是一个提示框,用来放备注信息。

注意

这是一个警告框,用来提醒重要事项。

8. 文章头部信息(Front Matter)

每篇文章最开头的 --- 之间的内容叫头部信息,可以写标题、日期和标签,方便以后整理:

---
title: 示例文章
date: 2026-08-11
tags:
  - 教程
---

以后写新文章时,复制本文件,把 titledatetags 改成你自己的,然后修改正文内容就可以了。