掌握Github风格Markdown:备忘单使用指南

下载需积分: 10 | ZIP格式 | 3KB | 更新于2024-12-28 | 182 浏览量 | 0 下载量 举报
收藏
资源摘要信息:"Github-Flavoured-Markdown:Github风味Markdown备忘单" Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。Github作为全球最大的代码托管平台,提供了一种基于Markdown的扩展版本,即Github风味Markdown(Github-Flavoured-Markdown,简称GFM),在标准Markdown语法的基础上增加了一些功能和特性,以便更好地适应Git项目的文档编写。 一、标准Markdown语法基础 Markdown的基本语法涉及标题、段落、格式化、引用、列表、代码块等。以下是几个基础知识点: 1. 标题 标题可以通过在行首添加1到6个井号(#)来创建,对应不同的标题层级,例如: ```markdown # 这是一级标题 ## 这是二级标题 ### 这是三级标题 #### 这是四级标题 ##### 这是五级标题 ###### 这是六级标题 ``` 2. 段落 Markdown的段落是由一个或多个连续的文本行组成,段落之间通过一个空行分隔。在Markdown中,直接书写文字即表示一个段落。 3. 格式化 Markdown支持加粗、斜体和删除线等基本格式化: - 加粗:使用两个星号或下划线包裹文本,例如`**加粗文本**`或`__加粗文本__`。 - 斜体:使用一个星号或下划线包裹文本,例如`*斜体文本*`或`_斜体文本_`。 - 删除线:使用两个波浪号包裹文本,例如`~~删除线文本~~`。 4. 引用 引用使用右尖括号`>`加上引用文本,例如: ```markdown > 这是一个引用示例。 ``` 5. 列表 Markdown支持无序列表和有序列表,无序列表使用星号`*`、加号`+`或减号`-`开始,有序列表则使用数字后跟点或圆括号开始,例如: ```markdown * 列表项一 + 列表项二 - 列表项三 1. 有序列表项一 2. 有序列表项二 ``` 6. 代码块 代码块可以使用反引号`` ` ``包裹代码行,或使用四个空格缩进表示。例如: ```markdown `inline code` ``` 二、Github风味Markdown(GFM)扩展特性 Github风味Markdown在标准Markdown的基础上增加了一些额外的语法,以增强文档的表现力和互动性。 1. 任务列表 任务列表允许在列表项前使用`[ ]`或`[x]`来标记任务的完成状态,例如: ```markdown - [x] 完成任务一 - [ ] 完成任务二 ``` 2. 表格 GFM支持在Markdown中创建表格,表格由表头和表体组成,使用竖线`|`分隔列,例如: ```markdown | 标题一 | 标题二 | 标题三 | | ------ | ------ | ------ | | 单元格1 | 单元格2 | 单元格3 | ``` 3. 删除线 除了标准Markdown的删除线语法外,GFM还允许在任何非代码元素的单词或字符上添加删除线,例如: ```markdown ~~删除~~ ``` 4. 代码高亮 GFM支持在代码块中使用特定的语法高亮,通过在反引号后指定语言名称实现,例如: ```markdown ```javascript // JavaScript代码块 var x = 10; ``` ``` 5. 自动链接 GFM会自动将URL或者email地址转换为链接,例如: ```markdown http://www.example.com ``` 6. 图片 在Markdown中嵌入图片使用感叹号`!`,后接`[alt文本]`和图片链接,例如: ```markdown ![替代文本](/path/to/image.jpg) ``` 7. 指令(表情符号、撤消线等) GFM支持使用特定的符号来插入表情符号或撤消线等特殊指令,例如: ```markdown :smile: // 表示一个微笑的表情 ~~撤消线~~ ``` 8. @提及 在讨论、评论或问题中,可以直接使用`@username`提及其他用户,例如: ```markdown @githubuser ``` 以上就是关于Github风味Markdown的基础知识。它在标准Markdown的基础上扩展了一些功能,使得Markdown文件更加丰富和灵活,尤其适合在Github项目中编写readme文档或编写技术博客。学习并掌握这些知识对于提升技术文档编写的效率和质量非常重要。

相关推荐