使用readme.md文件中的Github Markdown可能不知道的提示和技巧

本文概述

• 嵌入图像
• 固定的图像宽度或高度
• 居中图像
• 突出显示代码块
• 表情符号
• 任务清单
• 嵌入YouTube视频

Markdown是一种轻量级且易于使用的语法, 用于设置GitHub平台上所有形式的写作的样式。

Markdown是一种在网络上设置文字样式的方法。你可以控制文档的显示；将单词格式化为粗体或斜体, 添加图像以及创建列表只是Markdown可以做的一些事情。通常, Markdown只是带有一些非字母字符的常规文本, 例如＃或*。

你可以在GitHub周围的大多数地方使用Markdown：

• 要点
• 问题评论和请求请求
• 扩展名为.md或.markdown的文件

嵌入图像

有两种方法可以在readme.md文件中添加图像：

降价促销

使用以下语法添加图像。

![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

的HTML

使用以下语法通过html添加图像。

<img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" title="Github Logo">

固定的图像宽度或高度

要为图像提供固定尺寸, 请使用width和height属性。 (请记住, 使用html仅对Github有效)：

<img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" width="256" height="256" title="Github Logo">

居中图像

为了使图像居中, 我们将不使用传统标记, 而是使用纯html：

<p align="center">
  <img src="https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png" width="256" title="Github Logo">
</p>

突出显示代码块

要突出显示一段代码, 请将你的代码用6个引号引起来, 然后加上该语言的名称。代码块是Markdown规范的一部分, 但语法高亮不是。但是, 许多渲染器(例如Github和Markdown Here)都支持语法突出显示。支持哪种语言以及应如何书写这些语言名称将随渲染器的不同而不同。

```javascript
function hello(name) {
  console.log(name);
}
```

表情符号

Github Markdown支持嵌入式表情符号, 请访问表情符号备忘单以查看表情符号的完整列表。

:kissing: :laughing: :neutral_face:

任务清单

你可以使用markdown创建待办事项列表, 该列表将转换为复选框列表。如果在”问题”的第一条注释中包含任务列表, 则问题列表中将提供方便的进度指示器。它也适用于拉取请求。

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

嵌入YouTube视频

可惜的是, 这是不可能的。但是, 有一个小技巧可以让你创建图像并将用户重定向到youtube视频页面。

只需将YOUTUBE_VIDEO_ID_HERE替换为你的视频ID。将会出现一个图像, 该图像将自动重定向到youtube中的视频。

<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE" target="_blank">
 <img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" />
</a>

或使用纯降价促销(无尺寸)：

[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

你是否还有其他有用的提示, 而我们在本系列中没有？请在评论框中与我们分享。