使用 Markdown 进行交流
学习使用Markdown组织您的idea以及协作沟通。Markdown 是一种轻量级的文本格式化语言，通常以.md作为文件后缀名，它使用起来比word更快捷方便，比txt表达更丰富。
Welcome
GitHub 不仅仅是关于代码。 它是一个软件协作平台，Markdown 是开发人员在问题和拉取请求中进行清晰沟通和组织的最重要方式之一。 本课程将引导您更有效地创建和使用标题，在项目符号列表中组织想法，并显示您使用清单完成了多少工作。 您甚至可以使用 Markdown 借助表情符号、图像和链接为您的工作增添一些深度。
- 目标人群: 初级开发者，GitHub 新用户，学生等
- 课程目标: 使用 Markdown 插入列表、图片、以及超链接
- 你将构建: 我们将纯文本文件更新为Markdown格式
- 前置条件: 本课我们将用到拉取请求。如果您不熟悉，推荐先学习我们之前的课程
- 学习时长: 小于一个小时
通过本课程，您将
- 添加标题
- 插入图片
- 插入代码块
- 制作任务清单
- 合并您的拉取请求
如何开始
-
右键点击上方 Start course 按钮
-
在新页面中根据系统提示新建一个仓库。
- 仓库名称、描述这些字段系统已经帮我们自动填充好了，您可以按需修改。
- 建议使用选择公共仓库，因为私有仓库 GitHub Action有免费额度限制
- 最后点击 Create repository 按钮
-
仓库创建完毕后，等待大约 20 秒（等待Action执行），然后刷新页面。注意是刷新您仓库的页面，不是本课程的页面。如果页面没有变化，请继续等待。
接下来，我们将按照新建仓库中的README说明，进行分步操作。
步骤1：添加标题
示例
# 这是`<h1>` header，一级标题,
## 这是 `<h2>` header, 二级标题
###### 这是 `<h6>` header, 最小的标题
渲染后的效果
这是<h1> header，一级标题,
这是 <h2> header, 二级标题
这是 <h6> header, 最小的标题
⌨️ 练习
-
打开 pull requests tab页
-
点击 New pull request，选择比较
base: main和compare: start-markdown -
点击 Create pull request
-
点击此拉取请求中 Files changed tab，我们为您创建了一个空文件
index.md -
点击右下角"..."，选择编辑
index.md -
在编辑框内输入
#，然后一个空格，后面紧接着是标题内容。（小编注：使用英文，中文可能导致action执行失败，无法到步骤2） -
编辑好内容后，点击 Preview 进行预览
-
点击Commit changes，提交修改
-
等待大约20秒，然后刷新页面。GitHub Actions 将自动更新到下一步。
步骤2：添加一张图片
图片的语法格式如下
示例
渲染后的样子
⌨️ 练习
-
和步骤1一样，在pull request中编辑
index.md -
添加图片Markdown
-
点击预览测试图片是否正常显示
-
提交修改
-
等待大约20秒，然后刷新页面。GitHub Actions 将自动更新到下一步。
步骤3：插入代码块
示例一
``` $ git init Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/ ```
渲染后的样子
$ git init
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
示例二
可以指定编程语言
``` javascript var myVar = "Hello, world!"; ```
渲染后效果
var myVar = "Hello, world!";
⌨️ 练习
-
和前面步骤一样，在pull request中编辑
index.md -
插入代码Markdown
-
点击预览测试显示是否正常
-
提交修改
-
等待大约20秒，然后刷新页面。GitHub Actions 将自动更新到下一步。
步骤4：制作一个任务清单
什么是任务清单（task list）? 它是指一个带有勾选框的清单列表。它们对于跟踪问题和拉取请求非常有用。 如果您在问题或拉取请求的正文中包含任务列表，您将在问题列表中看到进度指示器。
示例
- [x] List syntax is required
- [x] This item is complete
- [ ] This item is not complete
渲染后的效果
- [x] List syntax is required
- [x] This item is complete
- [ ] This item is not complete
⌨️ 练习
GitHub Actions went ahead and made a branch for you. So you'll need to add to the file we've created in the branch, and we will check your work as you work through this course!
- Return to your pull request.
- Use Markdown to create a task list. Here is an example:
- [ ] Turn on GitHub Pages
- [ ] Outline my portfolio
- [ ] Introduce myself to the world
Remember, a task list starts with the syntax - [ ] and then the task list item. The formatting is specific!
-
Use the Preview tab to check your Markdown formatting.
-
Commit the changes to the file.
-
等待大约20秒，然后刷新页面。GitHub Actions 将自动更新到下一步。
步骤5：合并您的拉取请求
现在您可以合并您的pull request!
-
点击 Merge pull request
-
等待大约20秒，然后刷新页面。GitHub Actions 将自动更新到下一步。
完成
恭喜您完成了本课！
课程回顾：
- 学习关于Markdown、标题、图片、插入代码块、任务清单
- 学会如何创建和合并Markdown文件
- 您学习了一项基本的 GitHub 技能 🎉