github是用什么markdown

回复

共3条回复 我来回复
  • fiy的头像
    fiy
    Worktile&PingCode市场小伙伴
    评论

    GitHub使用的是标准的Markdown语法进行文档和文件的编写。Markdown是一种轻量级的标记语言,它使用简单的符号和易于阅读的文本格式来标记和格式化文档。

    在GitHub上,可以在各种文档和文件中使用Markdown语法,包括README文件、Wiki页面、Issue描述、Pull Request描述等。使用Markdown可以方便地添加标题、列表、链接、图片、代码块等元素,使文档更具有可读性和可维护性。

    下面是一些常用的Markdown语法示例:

    1. 标题:

    “`
    # 一级标题
    ## 二级标题
    ### 三级标题
    “`

    2. 列表:

    “`
    – 无序列表项1
    – 无序列表项2

    1. 有序列表项1
    2. 有序列表项2
    “`

    3. 链接和图片:

    “`
    [链接文本](链接URL)
    ![图片描述](图片URL)
    “`

    4. 代码块:

    “`
    ​“`
    代码块
    ​“`
    “`

    以上仅为Markdown语法的一些基本示例,GitHub还支持更多高级功能,例如表格、引用、任务列表等。

    总之,GitHub使用的是标准的Markdown语法,使用简单直观,方便开发者编写和编辑文档,同时能够自动渲染显示效果。

    2年前 0条评论
  • 不及物动词的头像
    不及物动词
    这个人很懒,什么都没有留下~
    评论

    GitHub 使用的是一种扩展的 Markdown 语法,称为GitHub Flavored Markdown(简称为GFM)。它在标准的Markdown语法的基础上做了一些扩展和修改,以支持更丰富的功能和更好的呈现效果。以下是 GFM 的几个主要特点:

    1. 任务列表:GFM 允许在 Markdown 的列表语法中添加复选框,可以用来表示任务列表。语法是在列表项前面使用 `- []` 或 `- [x]` 来表示未完成或已完成的任务。

    2. 表格:GFM 支持表格的语法,可以使用 `|` 和` – `表示表格的行和列。可以设置表头、表格对齐、单元格合并等。

    3. 自动链接:GFM 支持自动识别 URL 和电子邮件地址,并将其转换成可点击的链接。只需要简单地写下链接的地址,GFM 会自动将其转换成可点击的超链接。

    4. 删除线:GFM 支持使用 `~~` 来表示删除线。可以在文本中使用 `~~` 将想要标记删除的部分包围起来,GFM 会将其显示为删除线。

    5. 代码块:GFM 支持代码块的语法,并能够根据代码的语言进行代码高亮。可以在代码块的前一行指定代码的语言,并使用三个反引号包围代码块。

    除了以上几个特点之外,GFM 还有其他一些扩展的语法,如表情符号、标题锚点、特殊字符转义等。这些扩展使得在 GitHub 上编写和展示 Markdown 格式的文档更加方便和美观。

    2年前 0条评论
  • worktile的头像
    worktile
    Worktile官方账号
    评论

    GitHub使用的是标准的Markdown语法。Markdown是一种轻量级标记语言,它可以以纯文本的形式编写,并且可以被直接转换成HTML。GitHub支持的Markdown语法包括以下几个方面:

    1. 标题:使用#来表示,一个#表示一级标题,两个#表示二级标题,以此类推,最多支持六级标题。

    2. 文本样式:使用*或_将文本包裹起来,可以实现斜体和加粗的效果。例如,使用*包裹的文本会显示为斜体,使用**包裹的文本会显示为粗体。

    3. 列表:可以使用*、-或+来标记无序列表,使用数字加点(1.、2.、3.等)来标记有序列表。

    4. 引用:使用>符号来表示引用。

    5. 代码块:使用三个反引号(“`)包裹起来的文本表示代码块。可以指定代码块的语言,以实现语法高亮效果。

    6. 链接:使用[链接文本](链接地址)的格式来创建链接。

    7. 图片:使用![图片描述](图片链接)的格式来插入图片。

    8. 表格:使用|符号进行分隔,使用-符号标记表头和表体。例如:

    | 表头1 | 表头2 |
    | —- | —- |
    | 内容1 | 内容2 |

    以上只是Markdown语法的一小部分,GitHub还支持更多的Markdown扩展语法,如任务列表、删除线、表情符号等。在GitHub上,可以在Markdown文档中灵活使用这些语法,以实现更好的文档格式。

    在GitHub上编写Markdown文档时,可以直接在浏览器中编辑,也可以使用常见的文本编辑器(如VS Code、Sublime Text等)来编写,然后将Markdown文档上传到GitHub仓库中即可。GitHub会自动将Markdown文档转换成HTML,并在网页上显示出来。

    2年前 0条评论
注册PingCode 在线客服
站长微信
站长微信
电话联系

400-800-1024

工作日9:30-21:00在线

分享本页
返回顶部