GitHub 渲染 Markdown 的全面指南

什么是 Markdown?

Markdown 是一种轻量级的标记语言,它可以通过简单的语法快速格式化文本。Markdown 常用于撰写文档,因为它易于阅读和编写。

GitHub 上的 Markdown 渲染

在 GitHub 上,Markdown 被广泛应用于项目文档、README 文件和讨论中。通过 GitHub 的 Markdown 渲染功能,用户可以轻松创建美观的文档。

Markdown 基本语法

在 GitHub 上渲染 Markdown 文件时,了解一些基本的 Markdown 语法非常重要。以下是一些常见的 Markdown 语法示例:

  • 标题:使用 # 来创建标题。数量越多,标题层级越低。
    示例: markdown

    二级标题

    三级标题

  • 加粗和斜体:使用 **__ 来加粗文本,使用 *_ 来倾斜文本。
    示例: markdown 加粗文本 斜体文本

  • 列表:可以使用 -+* 来创建无序列表,使用数字和句点创建有序列表。
    示例: markdown

    • 列表项一
    • 列表项二
    1. 第一项
    2. 第二项
  • 链接:使用 [链接文本](链接地址) 创建链接。
    示例: markdown GitHub

  • 图片:使用 ![替代文本](图片地址) 插入图片。
    示例: markdown GitHub Logo

GitHub 特殊的 Markdown 特性

GitHub 的 Markdown 渲染还有一些独特的功能,比如表格、任务列表和公式等。

  • 表格:使用 | 分隔列并使用 - 表示表头。
    示例: markdown | 列1 | 列2 | |—–|—–| | 内容1 | 内容2 |

  • 任务列表:在列表项前加 [ ] 创建未完成的任务,[x] 创建已完成的任务。
    示例: markdown

    • [x] 已完成的任务
    • [ ] 未完成的任务
  • 数学公式:使用 $...$$$...$$ 表示行内公式和块公式。
    示例: markdown $$E = mc

正文完