GitHub和Git笔记

本文主要记录一些GitHub和Git的使用笔记。

GitHub Markdown 语法

GitHub基于CommonMark规范拓展了markdown，称为GitHub Flavored Markdown (GFM)，目前在GitHub.com和GitHub Enterprise上支持用户内容的格式。包括README文件，issues和wiki均支持GFM语法。

代码diff

GFM中可以使用diff来显示代码的变更，具体用法为：
```diff
+ This is new code
- This is deleted code
```

展示效果为：

+ This is new code
- This is deleted code

创建Note、Important和Warning

GFM中可以用一下代码创建Note、Important和Warning框：

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.  

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.  

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.  

展示效果为：

更具体信息可以参考这里。

引用议题和拉取请求

在GitHub的issues里经常需要引用以前的议题，可以通过键入 # 在存储库中调出建议的议题和拉取请求的列表。 键入议题或拉取请求的编号或标题以过滤列表，然后按 Tab 或 Enter 键以填写选中的结果。

引用具体某行代码

在GitHub的issues讨论中经场需要引用repo中的某段代码，可以参照以下方法：

1. 找到要链接的代码：

   • 要链接到文件中的代码，请导航到该文件。
   • 要链接到拉取请求中的代码，请导航到该拉取请求并单击 “已更改文件”。 然后浏览到含有要包含在注释中的代码的文件，并单击“查看”。

2. 决定是选择一行还是一个范围。

   • 要选择单行代码，请单击行号以高亮显示该行。
   • 要选择代码范围，请单击范围内第一行的行号以高亮显示代码行。 然后，将鼠标停在代码范围的最后一行，按 Shift，再单击行号以突出显示范围。

3. 在行或一系列行的左侧，单击 。 在下拉菜单中，单击“复制永久链接”。

4. 导航到要链接到代码段的地方，粘贴即可。注意此类永久链接仅在其起源仓库中呈现为代码段。 在其他仓库中，永久链接代码段将呈现为 URL。

具体信息可查看这里.

---

更多的GFM使用方法可参考这里和这里。