Github readme语法-- markdown
README
该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在标准的markdown语法基础上做了扩充,称之为GitHub Flavored Markdown
。简称GFM
,GFM在GitHub上有广泛应用,除了README文件外,issues和wiki均支持markdown语法。
Author:Jelly
E-mail:879231132@qq.com
目录
- 横线
- 标题
- 文本
- 普通文本
- 单行文本
- 多行文本
- 文字高亮
- 链接
- 文字超链接
- 链接外部URL
- 链接本仓库里的URL
- 锚点
- 图片超链接
- 文字超链接
- 图片
- 来源于网络的图片
- GitHub仓库中的图片
- 列表
- 圆点列表
- 数字列表
- 复选框列表
- 块引用
- 代码
- 表格
- 表情
***、---、___显示虚横线
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
显示文本
普通文本
这是一段普通的文本
关于换行
直接回车不能换行,
可以使用<br>。 但是使用html标签就丧失了markdown的意义。
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果,不过这个行间距有点大。
单行文本
Hello,大家好,我是果冻虾仁。
文本块
欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安
部分文字高亮
Thank You
. Please Call
Me Coder
高亮功能更适合做一篇文章的tag
例如:java
网络编程
Socket
全双工
删除线
这是一个 删除线
斜体
斜体1
斜体2
粗体
粗体1
粗体2
组合使用粗体、斜体和删除线
斜粗体1
斜粗体2
斜粗体删除线1
斜粗体删除线2
链接
链接外部URL
我的博客 语法如下:
[我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")
链接的另一种写法
语法如下:
[我的博客][id]
[id]:http://blog.csdn.net/guodongxiaren "悬停显示"
中括号[ ]里的id,可以是数字,字母等的组合。这两行可以不连着写,一般把第二行的链接统一放在文章末尾,id上下对应就行了。这样正文看起来会比较干净。
链接本仓库里的URL
Book 语法如下:
[Book](./Book)
如果文件要引用的文件不存在,则待点击的文本为红色。引用的文件存在存在则文本为蓝色。
锚点
我们可以使用HTML的锚点标签(#
)来设置锚点:回到目录
但其实呢,每一个标题都是一个锚点,不需要用标签来指定,比如我们 回到顶部 不过不幸的是,由于对中文支持的不好,所以中文标题貌似是不能视作标签的。
显示图片
来源于网络的图片
GitHub仓库中的图片
给图片加上超链接
第一种
第二种
列表
圆点列表
- 昵称:果冻虾仁
- 别名:隔壁老王
- 英文名:Jelly
更多圆点
- 编程语言
- 脚本语言
- Python
- 脚本语言
数字列表
一般效果
就是在数字后面加一个点,再加一个空格。不过看起来起来可能不够明显。
面向对象的三个基本特征:
- 封装
- 继承
- 多态
数字列表自动排序
也可以在第一行指定1.
,而接下来的几行用星号*
(或者继续用数字1. )就可以了,它会自动显示成2、3、4……。
面向对象的七大原则:
- 开闭原则
- 里氏转换原则
- 依赖倒转原则
- 接口隔离原则
- 组合/聚合复用原则
- “迪米特”法则
- 单一直则原则
多级数字列表
和圆点的列表一样,数字列表也有多级结构:
- 这是一级的数字列表,数字1还是1
- 这是二级的数字列表,阿拉伯数字在显示的时候变成了罗马数字
- 这是三级的数字列表,数字在显示的时候变成了英文字母
- 四级的数字列表显示效果,就不再变化了,依旧是英文字母
- 这是三级的数字列表,数字在显示的时候变成了英文字母
- 这是二级的数字列表,阿拉伯数字在显示的时候变成了罗马数字
复选框列表
- C
- C++
- Java
- Qt
- Android
- C#
- .NET
您可以使用这个功能来标注某个项目各项任务的完成情况。
块引用
常用于引用文本
文本摘自《深入理解计算机系统》P27
令人吃惊的是,在哪种字节顺序是合适的这个问题上,人们表现得非常情绪化。实际上术语“little endian”(小端)和“big endian”(大端)出自Jonathan Swift的《格利佛游记》一书,其中交战的两个派别无法就应该从哪一端打开一个半熟的鸡蛋达成一致。因此,争论沦为关于社会政治的争论。只要选择了一种规则并且始终如一的坚持,其实对于哪种字节排序的选择都是任意的。
“端”(endian)的起源
以下是Jonathan Swift在1726年关于大小端之争历史的描述:
“……下面我要告诉你的是,Lilliput和Blefuscu这两大强国在过去36个月里一直在苦战。战争开始是由于以下的原因:我们大家都认为,吃鸡蛋前,原始的方法是打破鸡蛋较大的一端,可是当今的皇帝的祖父小时候吃鸡蛋,一次按古法打鸡蛋时碰巧将一个手指弄破了,因此他的父亲,当时的皇帝,就下了一道敕令,命令全体臣民吃鸡蛋时打破较小的一端,违令者重罚。”
块引用有多级结构
数据结构
树
二叉树
平衡二叉树
满二叉树
代码高亮
public static void main(String[]args){} //Java
int main(int argc, char *argv[]) //C
echo "hello GitHub"#Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp
显示表格
表头1 | 表头2 |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
表头1 | 表头2 |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
名字 | 描述 |
---|---|
Help | Display the help window. |
Close | Closes a window |
表格中也可以使用普通文本的删除线,斜体等效果
名字 | 描述 |
---|---|
Help | |
Close | Closes a window |
表格可以指定对齐方式
左对齐 | 居中 | 右对齐 |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
表格中嵌入图片
图片 | 描述 |
---|---|
baidu |
添加表情
Github的Markdown语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。
比如:blush:
,可以显示。
具体每一个表情的符号码,可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com。
但是这个网页每次都打开奇慢。。所以我整理到了本repo中,大家可以直接在此查看emoji。
Github readme语法-- markdown的更多相关文章
- Markdown编写github README.md
Markdown编写github README.md 一.在线编辑器StackEdit Markdown在线编辑器地址 中文:https://www.zybuluo.com/mdeditor 英文:h ...
- GitHub 风格的 Markdown 语法
GitHub 风格的 Markdown 语法 [译] GitHub 风格的 Markdown 语法 Original: GitHub Flavored Markdown - GitHub Help T ...
- GitHub支持的Markdown语法 GitHub Flavored Markdown
GitHub支持的Markdown语法,简称GFM.相比标准的Markdown(SM)语法,有少数几个区别,并添加了新的功能. 本位参考 GitHub Flavored Markdown 撰写.有兴趣 ...
- Markdown github 风格语法
某些效果cnblog无法支持,见 https://github.com/tanghammer/note/blob/master/Markdown%20github%E9%A3%8E%E6%A0%BC% ...
- github README.md教程
github README.md教程 总结 github中README.md通过特殊字符标记和缩进来达到格式控制,也可以用HTML标签来实现格式控制. 教程一: Markdown 的目标是实现「易读易 ...
- GitBook是一个命令行工具(Node.js库),我们可以借用该工具使用Github/Git和Markdown来制作精美的图书,但它并不是一本关于Git的教程哟。
GitBook是一个命令行工具(Node.js库),我们可以借用该工具使用Github/Git和Markdown来制作精美的图书,但它并不是一本关于Git的教程哟. 支持输出多种格式 GitBook支 ...
- 【MarkDown】github readme添加图片 Markdown语法添加图片,适用各种markdown语法
作者:程序员小冰,CSDN博客:http://blog.csdn.net/qq_21376985, QQ986945193 微博:http://weibo.com/mcxiaobing 首先给大家看一 ...
- github上ReadMe语法
大标题 =================================== 大标题一般显示工程名,类似html的\<h1\><br /> 你只要在标题下面跟上=====即可 ...
- GITHUB readme基本语法
一.标题写法: 第一种方法: 1.在文本下面加上 等于号 = ,那么上方的文本就变成了大标题.等于号的个数无限制,但一定要大于0个哦.. 2.在文本下面加上 下划线 - ,那么上方的文本就变成了中标题 ...
随机推荐
- 简洁 Abstract Factory模式(3.1)
镇楼 在某些书中使用了二维图说明抽象工厂模式.非常好,可是yqj2065不喜欢他们的产品族/产品等级,改成品牌/产品类型. 抽象工厂模式(abstract factory pattern)较工厂方法模 ...
- android99 拍照摄像
package com.itheima.camera; import java.io.File; import android.net.Uri; import android.os.Bundle; i ...
- MVC - 模型验证
使用MVC的数据验证特性可以自动实现客户端验证和服务端验证 假设有一个Employee类 public class Employee { public int ID { get; set; } pub ...
- DNS 和 IPv6 配置攻略
Windows 2003 DNS配置攻略 http://lgzeng2360.blog.51cto.com/275998/161908/ http://ask.zol.com.cn/q/21861.h ...
- oh-my-zsh配置 alias 指定指令别名
# vim ~/.zshrc alias ydocx="/Users/wanglili/work/mfe/ydoc/bin/ydoc" # source ~/.zshrc
- 解决在mybatis中使用CTE进行oracle查询数据类型为long的字段出现流关闭问题
今天把notice表中的content字段改为long字段后,含有该字段的使用CTE的查询语句报错了.提示一下错误 ### Cause: java.sql.SQLException: 流已被关闭 ; ...
- html5 meta标签属性整理
声明文档使用的字符编码 <meta charset='utf-8'> 声明文档的兼容模式 //指示IE以目前可用的最高模式显示内容<meta http-equiv="X-U ...
- NFC标签
2.4 NFC标签 NFC标签(以下也称tag)是一种带有NFC电路和天线的钱币大小的电子标签,见图2.1,小容量的标签售价约1元左右一枚. 基本标签类型有四种,以1至4来标识,各有不同的格式与容量. ...
- FromHandle函数
一 FromHandle() MFC 实际上是对内核对象HANDLE(如CDC的m_hDC,CWnd的m_hWnd)封装了这个句柄有关的所有操作,一个类生成一个新对象的时候这个句柄是无效的,要获得这个 ...
- 前不久一个swift项目用uicollectionview 用sdwebimage 加载图片,发生内存猛增,直接闪退的情况,简单说一下解决方案。
1.首先在appdelegate方法 didFinishLaunchingWithOptions SDImageCache.sharedImageCache().maxCacheSize=1024*1 ...