Markdown 额外语法支持 - GitHub Flavored Markdown

简介: Syntax highlighting 语法突显下面是一个例子,告诉你如何使用 GitHub 语法突显标记:function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}您也可以简单地将代码缩进四个空格:

Syntax highlighting 语法突显



下面是一个例子,告诉你如何使用 GitHub 语法突显标记:


function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}


您也可以简单地将代码缩进四个空格:

function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }


Task Lists 任务清单


- [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


如果您在问题的第一个注释中包含了一个任务列表,那么您将在问题列表中得到一个方便的进度指示器。 它也可以在 Pull Requests 中工作!


Tables 表格


您可以通过组合一个单词列表并用连字符-(对于第一行)划分它们,然后用管道 | 分隔每一列来创建表:

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column


Would become:


First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column


SHA references



任何对提交的 SHA-1散列的引用都会自动转换为 GitHub 上提交的链接。

16c999e8c71134401a78d4d46435517b2271d6ac
mojombo@16c999e8c71134401a78d4d46435517b2271d6ac
mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac


Issue references within a repository


任何引用发布或拉请求的号码都将自动转换为链接。

#1
mojombo#1
mojombo/github-flavored-markdown#1


Username @mentions



输入一个@符号,后面跟着一个用户名,会通知那个人来查看评论。 这被称为“@mention” ,因为你提到的是个人。 你也可以@提及组织中的团队。


Automatic linking for URLs


任何 URL (如 http://www.github.com/ 链接)都会自动转换成可点击的链接。


Strikethrough 删除



任何带有两个波浪线的单词(比如~~this~~)都会被划掉。


Emoji 表情符号



GitHub 支持表情符号 emoji !


要查看我们支持的所有图片,请查看 Emoji Cheat Sheet.


跳转到标题锚点


先定义一个#标题, 然后可以用[abcd...](#该标题)来定位该锚点


* [1 前言](#1-前言)
## 1 前言


效果:


image.png


image.png


参考


Mastering Markdown · GitHub Guides


https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown




目录
相关文章
|
6月前
markdown常用语法--花括号(超详细)
markdown常用语法--花括号(超详细)
|
程序员 Windows
markdown的基本语法
markdown的基本语法
96 0
|
2月前
【LaTex、markdown】常用语法写出漂亮的blog
【9月更文挑战第9天】本文介绍了使用LaTeX和Markdown编写美观博客的方法。LaTeX方面,需定义文档类型、设置标题与作者,并利用特定命令处理文本格式、列表、数学公式、图片和超链接。Markdown则通过井号表示标题级别,使用星号或下划线标记文本,简化列表和公式的编写,并以直观方式插入图片和链接。两者均可通过合理布局提升博客的可读性和视觉效果。
|
3月前
Markdown使用HTML语法实现复杂表格
Markdown使用HTML语法实现复杂表格
152 1
|
3月前
|
资源调度
机器人学 markdown数学公式常用语法
本文提供了Markdown中数学公式的常用语法,包括行内公式、行间公式、基本运算、矩阵、微积分、大小比较、开根号、表格、角标、头顶标、空格、括号、特殊字符、分式、文字、希腊字母以及分类括号的详细使用方法和示例。
62 1
|
4月前
|
自然语言处理 开发者 Python
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的 HTML 内容。Markdown 的语法简洁明了、学习容易,而且功能比纯文本更强。
|
4月前
|
JavaScript
vue 加载展示md文件(markdown语法 .md后缀的文件)
vue 加载展示md文件(markdown语法 .md后缀的文件)
808 0
揭秘Markdown:轻松掌握基础语法,让你的写作更高效、优雅!
揭秘Markdown:轻松掌握基础语法,让你的写作更高效、优雅!
|
5月前
markdown语法
学习Markdown基本语法:标题、段落、强调、列表、代码块等,轻松撰写整洁文档。[查看教程](https://markdown.com.cn/basic-syntax/)
46 0
|
6月前
Markdown基础语法详细版
Markdown基础语法详细版
下一篇
无影云桌面