GitHub支持的Markdown语法 GitHub Flavored Markdown
GitHub支持的Markdown语法,简称GFM。相比标准的Markdown(SM)语法,有少数几个区别,并添加了新的功能。
本位参考 GitHub Flavored Markdown 撰写。有兴趣的话可以看原文。
与标准Markdown的区别
对文本中下划线的处理方式不同
标准Markdown语法会把两个下划线 _
之间的文本转换为斜体。GFM中会忽略这种语法设置。如果需要设置斜体,建议使用 *
实现。注意仅仅是单个下划线的情况下,多个下划线的语法还是正常的。比如下面单词:
wow_great_stuff
do_this_and_do_that_and_another_thing
URL自动链接
GFM中支持标准URL的自动链接,不需要使用标准Markdown的URL超链接语法。比如,输入下面URL
http://example.com
自动显示为
http://example.com
支持删除线
GFM中添加了支持删除文本的语法,使用两个波浪线包含的文本,会自动添加删除线。(波浪线在键盘中没有直接输入的符号,所以慎用!)
比如,输入下面文本:
Strike Through
显示效果如下:
Strike Through
代码块包含语法
标准Markdown语法使用行开始四个空格表示引用代码块。GFM添见了新的代码块引用语法。只要使用 ```
包含对应的代码块就可以实现代码引用。(相比标准的用法,这样可以避免代码对齐和空格输入的麻烦。)
比如,
```
int test(void)
{
int m = 0;
}
```
效果如下:
int test(void){int m = 0;}
支持语法高亮
GFM的代码块支持语法高亮,只需要在 ```c++
(代码块起始后面加上语言名称即可)。比如下面效果是可以实现的。
#include <iostream>
int main(int argc, char * argv[])
{int i = 0;std::cout << i << std::endl;return 0;
}
表格创建
可以使用连字符 -
来表示表格的第一行,可以用管道符 |
表示表格的列。如下语法:
| First Header | Second Header |
| ------------ | ------------- |
| content cell | content cell |
| content cell | content cell |
显示效果如下:
First Header | Second Header |
---|---|
content cell | content cell |
content cell | content cell |
当然,实际使用中可以不用考虑表格每一行的字符对齐的要求。
比如下面这种语法也是可以的:
| Name | Description |
| ------------- | ----------- |
| Help | Display the help window.|
| Close | Closes a window |
效果如下:
Name Description Help Display the help window. Close Closes a window
表格单元项中也可以包含其他模块,比如超链接、斜体、加粗、删除线等。
也可以使用冒号 :
表示表格中单元格的对齐方式。如下语法:
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
显示效果如下:
Left-Aligned | Center Aligned | Right Aligned |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
冒号位于左边表示当前列左对齐显示,冒号位于右边表示当前列右对齐显示,冒号在两边各一个,表示居中显示。
任务列表
任务列表是在列表上添加[]、[x](分别表示未完成、完成状态)。输入下面文本:
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> are supported
- [x] list syntax is required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
显示效果是这样的:
- [x] @mentions, #refs, links, formatting, and
tagsare supported - [x] list syntax is required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
任务列表支持嵌套,但建议嵌套层数不超过2层。
参考资料
- GitHub Flavored Markdown
- Writing on GitHub
- Mastering Markdown
附件说明
鉴于博客园的markdown客户端渲染效果比较差,有兴趣的可以直接到参考资料中查看实际渲染效果。
转载于:https://www.cnblogs.com/tocy/p/github-flavored-markdown.html
GitHub支持的Markdown语法 GitHub Flavored Markdown相关推荐
- Markdown语法简介,markdown导出PDF
pdf导出 添加分页标志 <div style="page-break-after: always;"></div> 导出HTML 自动编号 扩展程序下载 ...
- GitHub Flavored Markdown 规范
Markdown是一种轻量级标记语言,它以纯文本形式编写文档,易读(看起来舒服).易写(语法简单).易更改,并最终以HTML格式发布.由于markdown没有明确指定语法,随着编译器不一样,实现方式有 ...
- 国产的markdown 语法的思维导图和大纲工具!
MarkMind 简介 MarkMind 是一款支持markdown语法的思维导图和大纲工具,主要特色就是在节点内部直接支持markdown语法. Markdown是一种纯文本格式的标记语言.通过简单 ...
- Markdown语法及效果展示
Markdown概述 Markdown是一个Web上使用的文本到HTML的转换工具. 也就是说用简单的文本实现网页文本的表示.使用一些特定的符号组合来达到对文本内容进行美化规整的功能. 锤 ...
- html嵌入式的脚本语言,Markdown语法及html内嵌
之前看到很多大佬博客写的特别漂亮,非常羡慕,他们是怎么排版的呢?作为一个小白,学习使我快乐....终于在不断摸索中,找到方法.原来大佬们使用了一个新的语言--Markdown. 1.Markdown介 ...
- 马克飞象 Markdown 语法,对应上一篇
# 马克飞象 使用笔记@(林木木的博客) [马克飞象|教程] ## Markdown 官方文档> 这里可以看到官方的 Markdown 语法规则文档:+ [创始人 John Gruber 的 M ...
- Markdown的前世今生 + CSDN的Markdown语法和使用大全
带你理解Markdown的前世今生 + CSDN的Markdown语法和使用大全 带你理解Markdown的前世今生 1. 码字面临的困境 2. 亚伦·斯沃茨的故事 3. Markdown的特点 4. ...
- Markdown语法文档,Markdown教程,Markdown语法大全,
写在前面 最近一段时间学习的同时也在做一些笔记,想着将笔记发布出来加深印象并能够方便查找,看了一些大佬的文章后,不得不感慨大佬们编写文章的整洁度和可读性,因此经过仔细斟酌后,只有Markdown才是用 ...
- Pandoc中的Markdown语法
概述 Pandoc中支持扩展修订版本的Markdown语法 使用pandoc中支持的Markdown语法用 -f markdown 使用标准Markdown语法用 -f markdown_strict ...
最新文章
- wps底纹去不掉_汽车异味总是去不掉?建议车主试试这5个办法,空气清新又好闻...
- [置顶] Java程序员们读什么书决定了对未来职业方向的选择
- 关于sql注入之cookie注入
- 整型和浮点型的区别_C的基础内容:常量之数值型常量,适合新手的学习
- 杂谈人工智能说大数据
- angularjs全栈开发知乎_为什么你要去尝试全栈开发?
- mysql中的if [not] exists
- 2.17_knight_tour_骑士周游问题 (深度优先 DFS)
- pagerank数据集_机器学习十大经典算法-PageRank(附实践代码)
- Linux之centos包管理rpm、yum、tar
- ildasm、ilasm修改、反编译 已经编译的 dll文件(c#)
- python 概率分布_Python中的联合概率分布
- 换个角度深入理解GlusterFS
- 学计算机颈椎,电脑颈
- 微信小程序修改标题背景色
- WordCloud库的安装教程
- AGV三种导航方式,苏州凌鸟带你走进AGV世界
- 今日头条 ANR 优化实践系列分享 - 实例剖析集锦
- extern 用法小结
- 未来可期(关于高考和现在处境的看法)
热门文章
- Sql中的格式转换功能
- 【Python beautiful soup】如何用beautiful soup 解析HTML内容
- Beautiful Soup是干什么用的
- 【问题已解决】Unrecognized option: --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED
- 桥接模式下无法连接到ens33网络
- Linux运维学习:中级进阶(2)——Linux企业常用服务(SSH、DHCP、FTP、NFS、DNS)
- 葵花宝典:JavaSE-day09
- ChatGPT4已经来了,30秒做一个弹球游戏!
- JQuery实现动态表格(添加、删除、遍历)
- latex h t b p是什么意思