书写README的各种markdown语法

README

该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在标准的markdown语法基础上做了扩充，称之为GitHub Flavored Markdown。简称GFM，GFM在GitHub上有广泛应用，除了README文件外，issues和wiki均支持markdown语法。

Authorbelieveszw
E-mail765846560@qq.com
Githubhttps://github.com/believeszw

目录

  • 横线
  • 标题
  • 文本
    • 普通文本
    • 单行文本
    • 多行文本
    • 文字高亮
    • 换行
    • 斜体
    • 粗体
    • 删除线
  • 图片
    • 来源于网络的图片
    • GitHub仓库中的图片
  • 链接
    • 文字超链接
      • 链接外部URL
      • 链接本仓库里的URL
    • 锚点
    • 图片链接
  • 列表
    • 无序列表
    • 有序列表
    • 复选框列表
  • 块引用
  • 代码高亮
  • 表格
  • 表情
  • diff语法

横线

***、—、___可以显示横线效果

标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本

普通文本

这是一段普通的文本

单行文本

Hello,大家好，我是果冻虾仁。

在一行开头加入1个Tab或者4个空格。

文本块

语法1

在连续几行的文本开头加入1个Tab或者4个空格。

欢迎到访
很高兴见到您
祝您，早上好，中午好，下午好，晚安

语法2

使用一对各三个的反引号：

欢迎到访
我是C++码农
你可以在知乎、CSDN、简书搜索【果冻虾仁】找到我

该语法也可以实现代码高亮，见代码高亮

文字高亮

文字高亮功能能使行内部分文字高亮，使用一对反引号。
语法：

`linux` `网络编程` `socket` `epoll`

效果：linux 网络编程 socket epoll

也适合做一篇文章的tag

换行

直接回车不能换行，
可以在上一行文本后面补两个空格，
这样下一行的文本就换行了。

或者就是在两行文本直接加一个空行。

也能实现换行效果，不过这个行间距有点大。

斜体、粗体、删除线

语法效果
*斜体1*斜体1
_斜体2_斜体2
**粗体1**粗体1
__粗体2__粗体2
这是一个 ~~删除线~~这是一个 删除线
***斜粗体1***斜粗体1
___斜粗体2___斜粗体2
***~~斜粗体删除线1~~***斜粗体删除线1
~~***斜粗体删除线2***~~斜粗体删除线2
斜体、粗体、删除线可混合使用

图片

基本格式：

![alt](URL title)

alt和title即对应HTML中的alt和title属性（都可省略）：

  • alt表示图片显示失败时的替换文本
  • title表示鼠标悬停在图片时的显示文本（注意这里要加引号）

URL即图片的url地址，如果引用本仓库中的图片，直接使用相对路径就可了，如果引用其他github仓库中的图片要注意格式，即：仓库地址/raw/分支名/图片路径，如：

https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
#语法效果
1[外链图片转存失败(img-vEtchDOQ-1566288187751)(http://www.baidu.com/img/bdlogo.gif "百度logo")][外链图片转存失败(img-JIUVHmnk-1566288187753)(http://www.baidu.com/img/bdlogo.gif “百度logo”)]
2![][code-past]

注意例2的写法使用了URL标识符的形式，在链接一节有介绍。

在文末有code-past的定义：

[code-past]:https://img-blog.csdnimg.cn/201908060004034.png

链接

链接外部URL

#语法效果
1[我的博客](https://blog.csdn.net/believe_s "悬停显示")我的博客

语法2由两部分组成：

  • 第一部分使用两个中括号，[ ]里的标识符（本例中zhihu），可以是数字，字母等的组合，标识符上下对应就行了（姑且称之为URL标识符）
  • 第二部分标记实际URL。

使用URL标识符能达到复用的目的，一般把全文所有的URL标识符统一放在文章末尾，这样看起来比较干净。

URL标识符是我起的名字，不知道是否准确。囧。。

链接本仓库里的URL

语法效果
[README](./README.md)README

图片链接

给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本，而图片链接[ ]里面则是要显示的图片。
直接混合两种语法当然可以，但是十分啰嗦，为此我们可以使用URL标识符的形式。

#语法效果
1[[外链图片转存失败(img-3jm1Qz26-1566288187754)(https://www.weibo.com/believeszw)][[外链图片转存失败(img-pcOhbHDa-1566288187755)(https://www.weibo.com/believeszw)]
2[[外链图片转存失败(img-7xvl2fyP-1566288187755)(/img/zhihu.png "我的知乎，欢迎关注")]][zhihu][外链图片转存失败(img-Ne6Tj9wI-1566288187756)(/img/zhihu.png “我的知乎，欢迎关注”)]
3[![csdn-logo]][csdn]csdn-logo

因为图片本身和链接本身都支持URL标识符的形式，所以图片链接也可以很简洁（见例3）。
注意，此时鼠标悬停时显示的文字是图片的title，而非链接本身的title了。

本文URL标识符都放置于文末

锚点

其实呢，每一个标题都是一个锚点，和HTML的锚点（#）类似，比如我们

语法效果
[回到顶部](#readme)回到顶部

不过要注意，标题中的英文字母都被转化为小写字母了。

以前GitHub对中文支持的不好，所以中文标题不能正确识别为锚点，但是现在已经没问题啦！

列表

无序列表

语法

* 昵称：believe_s
* 英文名：believe

效果

  • 昵称：believe_s
  • 英文名：believe

多级无序列表

语法

* 编程语言* 脚本语言* Python

效果

  • 编程语言
    • 脚本语言
      • Python

一级有序列表

语法

就是在数字后面加一个点，再加一个空格。不过看起来起来可能不够明显。

面向对象的三个基本特征：1. 封装
2. 继承
3. 多态

效果

面向对象的三个基本特征：

  1. 封装
  2. 继承
  3. 多态

多级有序列表

和无序列表一样，有序列表也有多级结构。

语法

1. 这是一级的有序列表，数字1还是11. 这是二级的有序列表，阿拉伯数字在显示的时候变成了罗马数字1. 这是三级的有序列表，数字在显示的时候变成了英文字母

效果

  1. 这是一级的有序列表，数字1还是1
    1. 这是二级的有序列表，阿拉伯数字在显示的时候变成了罗马数字
      1. 这是三级的有序列表，数字在显示的时候变成了英文字母

复选框列表

语法

- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付

效果

  • 需求分析
  • 系统设计
  • 详细设计
  • 编码
  • 测试
  • 交付

您可以使用这个功能来标注某个项目各项任务的完成情况。

Tip:

在GitHub的issue中使用该语法是可以实时点击复选框来勾选或解除勾选的，而无需修改issue原文。

块引用

常用于引用文本

文本摘自《深入理解计算机系统》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
表格单元表格单元
表格单元表格单元
表头1表头2
表格单元表格单元
表格单元表格单元

对齐

表格可以指定对齐方式

左对齐居中右对齐
col 3 issome wordy text$1600
col 2 iscentered$12
zebra stripesare neat$1

混合其他语法

表格单元中的内容可以和其他大多数GFM语法配合使用，如：

使用普通文本的删除线，斜体等效果

名字描述
HelpDisplay the help window.
CloseCloses a window

表格中嵌入图片（链接）

其实前面介绍图片显示、图片链接的时候为了清晰就是放在在表格中显示的。

图片描述
baidu百度

表情

Github的Markdown语法支持添加emoji表情，输入不同的符号码（两个冒号包围的字符）可以显示出不同的表情。

比如:blush:，可以显示?。

具体每一个表情的符号码，可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com。

但是这个网页每次都打开奇慢。。所以我整理到了本repo中，大家可以直接在此查看emoji。

diff语法

版本控制的系统中都少不了diff的功能，即展示一个文件内容的增加与删除。
GFM中可以显示的展示diff效果。使用绿色表示新增，红色表示删除。

语法

其语法与代码高亮类似，只是在三个反引号后面写diff，
并且其内容中，可以用 +开头表示新增，-开头表示删除。
另外还有有 !和#的语法。

效果

+ 人闲桂花落，
- 夜静春山空。
! 月出惊山鸟，
# 时鸣春涧中。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/448128.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Apache2.4配置ssl

Apache2.4配置ssl

1》验站 如下截图，验站就是在DNS域名商哪里，在对应host下面，添加一个TXT记录类型，主机记录，记录值后，检测即可。　　 2》SSL证书申请 阿里云，腾讯云有很多免费证书申请，免费的缺点是…
阅读更多...
助你解决新手开车四大问题 为您支招

助你解决新手开车四大问题 为您支招

新手开车起步技巧涉及方方面面，对于新手来说，如何首次将车独自开上路且不发生任何意外是众多人热切盼望的理想方式。但是新手上路难免会磕磕碰碰，发生小摩擦都是在所难免的，那么如何在起步阶段就将发生事故的概率降到最低呢?在此…
阅读更多...
VUE - get 、post 请求后端接口：get 、post 写法 （Axios 中文说明文档地址）

VUE - get 、post 请求后端接口：get 、post 写法 （Axios 中文说明文档地址）

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。 Axios 中文使用说明文档地址：Axiox 中文说明文档 我只是记录下写法，两种请求都能正常运行： 1. 安装…
阅读更多...
离合器半联动点的判断和技巧 为您支招

离合器半联动点的判断和技巧 为您支招

现在将离合器半联动的使用方法揭密如下：将离合器抬到车开始动时你就别再抬了，你如果感觉到车有些快了，可再往下踩些，你如果感觉到车有些慢了，可再往起抬些，这样可将车速控制在你想要的速度范围之内。 ● 坡…
阅读更多...
VUE：组件间相互跳转、页面带参跳转

VUE：组件间相互跳转、页面带参跳转

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。 只是记录下用法： 从 A 页面跳转到 B 页面。 如下写法： A 页面跳转方式： 代码： getdat…
阅读更多...
如何调整反光镜和座椅的位置 为您支招

如何调整反光镜和座椅的位置 为您支招

【太平洋汽车网　学车频道】首先要进行座椅的高度调整，上下调整座椅让头部离车顶至少还有一拳的距离。如果座椅调得太高，车辆在颠簸时头部容易碰到车顶，调得太矮了又会影响视线。然后是前后距离的调整，当脚踩住制动踏板至最深处时…
阅读更多...
关于hexo与github使用过程中的问题与笔记

关于hexo与github使用过程中的问题与笔记

快速阅读 如何用github 和hexo 创建一个blog 1.github中要新建一个与用户名同一样的仓库， 如:homehe.github.io - 必须是io后缀。一个帐户 只能建立一个2. 绑定域名 ， A记录指向ip, cname记录指向homehe.github.io 3. 配置sshkey - 个人设置 -> SSH a…
阅读更多...
CSS 中 的 margin、border、padding 区别 （内边距、外边距）

CSS 中 的 margin、border、padding 区别 （内边距、外边距）

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。 图解CSS padding、margin、border属性 W3C组织建议把所有网页上的对像都放在一个盒(box)中，设计师可以通过创建定义来控制这…
阅读更多...
什么是转向灯？使用转向灯有何技巧？

什么是转向灯？使用转向灯有何技巧？

什么是转向灯？如何使用转向灯？新手司机对车辆还不是很熟悉，如何正确使用转向灯，尤其是在不同路段中该怎么正确使用转向灯，成为了很多新手们的困扰之一，今天我们就来为大家解决这个问题吧！ 转向灯…
阅读更多...
集合练习：登录注册功能

集合练习：登录注册功能

需求： 1、登录账号唯一，在注册时验证输入的账号是否可用，若已存在，则不可用，若不存在则可用2、登录时使用账号密码进行验证1 /**2 * author Administrator3 * 登录信息 4 */5 public class UserLogin {6 …
阅读更多...
vue 通信、传值的多种方式（超详细）

vue 通信、传值的多种方式（超详细）

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。 一、通过路由带参数进行传值 ①两个组件 A和B,A组件通过query把orderId传递给B组件（触发事件可以是点击事件、钩子函数等&am…
阅读更多...
新手开车 驾驶小秘诀要牢记

新手开车 驾驶小秘诀要牢记

有很多人刚买到新车兴奋异常，凭着并不熟练的驾驶技术，过了几天的车瘾后发现，刚买的车怎么出现了这样那样的问题 有很多人刚买到新车兴奋异常，凭着并不熟练的驾驶技术，过了几天的车瘾后发现，刚买的车怎么出现…
阅读更多...
C++没有调用析构函数

C++没有调用析构函数

github地址 在项目中遇到一个问题，析构函数没有调用产生了内存泄露。 具体见valgrind检测libevent内存泄露 我们看两个例子 demo1 class Test1; void del(Test1* obj){delete obj; } class Test1{ public:Test1(){printf("Test1\r\n");}~Test1(){pri…
阅读更多...
实际操作之路考的这些事

实际操作之路考的这些事

辛苦了这么久练习路考，今天终于实际操作到我路考了。上车以后。关上车门。把考试的单地上给考官。还没有认真的去看考官一眼。于是就听到考官用低沉的声音对我说：你好！当时就感觉有一点意外。没想到考官你这么有礼貌。然后我就没那么紧张了&a…
阅读更多...
[C# 网络编程系列]专题十二：实现一个简单的FTP服务器

[C# 网络编程系列]专题十二：实现一个简单的FTP服务器

引言： 休息一个国庆节后好久没有更新文章了，主要是刚开始休息完心态还没有调整过来的， 现在差不多进入状态了， 所以继续和大家分享下网络编程的知识，在本专题中将和大家分享如何自己实现一个简单的FTP服务器。在我们平…
阅读更多...
vue 2 使用 Bus.js 实现兄弟 (非父子) 组件通信 简单案例

vue 2 使用 Bus.js 实现兄弟 (非父子) 组件通信 简单案例

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到教程。 vue2中废弃了$dispatch和$broadcast广播和分发事件的方法。父子组件中可以用props和$emit()。如何实现非父子组件间的通信，可…
阅读更多...
jenkins自动化部署

jenkins自动化部署

jenkins自动化部署 github地址 首先设置源码地址，jenkins会从仓库中拉取最新代码 拉取代码后运行shell脚本自动进行编译 cd mediaService cmake -S . -B cmake-build-release-hisi3531 -DCMAKE_C_COMPILER/opt/hisi-linux/x86-arm/arm-hisiv500-linux/target/bin…
阅读更多...
学开车不能急于求成,心急上路

学开车不能急于求成,心急上路

我发现很多人开始学开车以后就急着要上路，觉得开车是很简单的事情，个人觉得开车虽然不难（相对于会开车的人来说），但是，虽然不是很难，也不是一学会开车起步就能上路去潇洒的。急于求成的人很容易…
阅读更多...
valgrind检测libevent内存泄露

valgrind检测libevent内存泄露

valgrind检测libevent内存泄露 github地址 在使用封装好的http库时，遇到了如下的内存泄露，一开始在definitely处还存在泄露，这里就不贴图了，已经被淹没了。 根据提示定位出错代码位置，如下图： 这里提示ev…
阅读更多...
大佬（概率期望DP）

大佬（概率期望DP）

首先根据数据范围，可以判断基本上是n^2的复杂度 通过分析我们发现每一次都可以从m个数中任意选，既然任意选，那么此时的概率的分母就是不变的，然而题中涉及的是某一段的最大值，所以我们按套路假设 f[i][j]表示第i天&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023