返回训练营 /使用 Markdown 进行沟通

使用 Markdown 进行沟通

Markdown 是一种轻量级纯文本标记语言，在 GitHub 上几乎无处不在

这是一个交互式课程，需要在 GitHub 上实际操作来完成学习。本页面为静态预览，方便您一次性阅读所有步骤内容。
前往 GitHub 开始学习

课程概览

Markdown 作为一种轻量级标记语言，具备易读、易写的特点，能够帮助开发者在 GitHub 中更清晰地表达想法、发表评论以及编写文档。本课程将带你逐步掌握 Markdown 的常见用法。

目标人群初级开发者，GitHub 新用户和学生
学习内容掌握在评论或文本文件中使用 Markdown 添加列表、图片与链接的方法
您将完成对一个纯文本文件使用 Markdown 格式重写，并可基于该文件搭建 GitHub Pages 页面
先决条件课程中会涉及 pull request 和文件编辑，建议先学习 GitHub 入门课程
学习时长不到一个小时
1添加标题2创建列表3添加代码示例4添加图片5完成任务
步骤 1

添加标题

什么是 Markdown：Markdown 是 GitHub 使用的一种轻量级文本标记语言，通过它可以对文本进行格式化处理，如插入标题、列表、加粗、斜体、表格等。

什么是标题：标题用来标识某一部分内容主题，一共分为六级（H1-H6）。

实操环节

  1. 在顶部导航栏中选择 Code tab 页
  2. 创建一个新分支，名称为 start-blog
  3. 点击 Add file → Create new file
  4. 输入文件名：day-1.md
  5. 在编辑器中使用一级标题：# Daily Learning
  6. 添加两个二级标题：## Morning Planning 和 ## Review
  7. 点击 Preview 查看渲染效果
  8. 点击 Commit changes 提交到 start-blog 分支
markdownMarkdown 标题示例
# Daily Learning

## Morning Planning

## Review
`#` 和第一个单词之间必须有一个空格
步骤 2

创建列表

Markdown 支持 3 种列表类型：
- 无序列表：使用 -、* 或 +
- 有序列表：使用数字编号
- 任务列表：带复选框的列表，[ ] 未完成，[x] 已完成

实操环节

  1. 在 start-blog 分支中打开 day-1.md
  2. 在 Morning Planning 下方添加任务清单
  3. 切换到 Preview 检查渲染效果
  4. 点击 Commit changes 提交
markdown任务列表示例
- [ ] 查看 [GitHub Blog](https://github.blog/) 获取选题灵感
- [ ] 学习 GitHub Pages 的使用方法
- [ ] 将我的第一篇博客转换为网页形式
`[ ]` 内部必须包含一个空格
步骤 3

添加代码示例

使用代码块（code blocks）可以根据不同编程语言实现语法高亮。使用三个反引号 ` 包裹代码，并指定语言类型。

实操环节

  1. 在 start-blog 分支中打开 day-1.md
  2. 在 Review 下方添加代码示例
  3. 点击 Preview 检查显示效果
  4. 点击 Commit changes 提交
markdown代码块示例
```bash
ffmpeg -i input.mp4 -vf "negate,hue=h=180,eq=contrast=1.2:saturation=1.1" output.mp4
```
使用三个反引号 ` ``` `，不是三个单引号
步骤 4

添加图片

在 Markdown 中插入图片有两种方式：
- Markdown 语法：!描述
- HTML 语法：<img> 标签，可控制大小和对齐

实操环节

  1. 在 day-1.md 的 Morning Planning 下方插入图片
  2. 先尝试 Markdown 语法
  3. 再替换为 HTML 版本控制大小
  4. 点击 Commit changes 提交
htmlHTML 图片示例
<img alt="Cloudy morning" src="https://octodex.github.com/images/cloud.jpg" width="100" align="right">
HTML img 标签必须包含 src 属性
步骤 5

完成任务

将博客内容合并到 main 主分支中。

实操环节

  1. 点击 Pull requests 标签页
  2. 创建新 PR：base 为 main，compare 为 start-blog
  3. 填写标题和描述
  4. 点击 Merge → Merge pull request 完成合并

课程回顾

恭喜你顺利完成本课程！下面简单回顾一下你学到的内容：

  • 添加了标题，更好地组织内容结构
  • 创建了任务清单，规划和跟踪待办事项
  • 保存了代码示例，方便后续参考
  • 插入了图片，让内容更直观生动
  • 用 Markdown 完成了一篇完整的博客内容
返回训练营 在 GitHub 上查看