Github Makedown 语法入门

2024-02-15 02:58
文章标签 入门 语法 github makedown

本文主要是介绍Github Makedown 语法入门,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

GitHub上创建GitHub项目,会包含了一个 README.md 文件,此文件编辑就会用到Markdown

本文将详细介绍Markdown文件(md文件)的语法。

 

本文示例开源项目,请见GitHub

https://github.com/mimvp/mimvp-markdown-syntax

 

1. 新建GitHub项目

文本以米扑科技的项目库为例:mimvp

新建项目链接:https://github.com/organizations/mimvp/repositories/new

github-makedown-yu-fa-ru-men-01

 

2. 查看创建项目

mimvp-markdown-syntax

github-makedown-yu-fa-ru-men-02

 

3. 下载编辑 README.md   

0) 克隆项目到本地

https://github.com/mimvp/mimvp-markdown-syntax.git

编辑好README.md文件后,再提交上传到GitHub,这种方式效率低。

 

推荐一种更快捷的编辑README.md方式,直接在Github上编辑(推荐

a)点击 README.md文件

b)点击下图红框,直接编辑

github-makedown-yu-fa-ru-men-03

 

1)Markdown 标题

markdown 支持两种标题的语法:Setext 和 atx 形式,两者也可以结合使用,效果更好!

a)Setext 形式

用底线的形式,利用 === (最高阶标题)和 ----- (第二阶标题)

Markdown 语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
米扑科技
========
官网 [http: //mimvp .com](http: //mimvp .com)
官网 <a target= "_blank" href= "http://mimvp.com" >http: //mimvp .com< /a >
米扑代理
--------
官网 [http: //proxy .mimvp.com](http: //proxy .mimvp.com)
米扑域名
--------
官网 <a target= "_blank" href= "http://domain.mimvp.com" >http: //domain .mimvp.com< /a >
米扑财富
--------
官网 <a href= "http://money.mimvp.com" target= "_blank" >http: //money .mimvp.com< /a >

Markdown 结果:

github-makedown-yu-fa-ru-men-04

 

b)atx 形式

用#号标识标题,最多六级标题(不支持七级、八级等标题,会直接显示出文字)

Markdown 语法:

1
2
3
4
5
6
7
8
9
标题示例
========
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

Markdown 结果:

github-makedown-yu-fa-ru-men-06

 

2)Markdown 代码块

代码块,以大于号(>)开头。若末尾不加换行符<br/>,则所有文字会连接在一起不会换行。

Markdown 语法:

1
2
3
4
5
6
Markdown 代码块
========
> 米扑科技,小而美,简而信,工匠艺术的互联网服务。 <br/>
> 米扑团队,来自百度、小米、创新工场、阿里,核心研发,实战经验丰富。 <br/>
> 米扑产品,已上线服务包括米扑代理、米扑域名、米扑支付、米扑财富、米扑博客等。 <br/>
> 米扑科技官网: [mimvp.com](http: //mimvp .com)

Markdown 结果:

github-makedown-yu-fa-ru-men-07

 

3)Markdown 引用块

引用块,以特殊引号(`)开头。注意:不是单引号,而是特殊引号,在键盘左上角的“esc”左下方的那个按键

Markdown 语法:

1
2
3
4
5
6
7
8
9
Markdown 引用块
========
米扑科技简介
```
米扑科技,小而美,简而信,工匠艺术的互联网服务。
米扑团队,来自百度、小米、创新工场、阿里,核心研发,实战经验丰富。
米扑产品,已上线服务包括米扑代理、米扑域名、米扑支付、米扑财富、米扑博客等。
米扑科技官网: mimvp.com
```

Markdown 结果:

github-makedown-yu-fa-ru-men-08

 

4)Markdown 代码高亮

代码高亮,以特殊引号(`)开头,并跟上代码语言,例如:python、java、javascript、ruby、perl、go、c、c++、bash等。

注意:不是单引号,而是特殊引号,在键盘左上角的“esc”左下方的那个按键

Markdown 语法:

1
2
3
4
5
6
7
8
9
10
11
Markdown 代码高亮
========
```python
#!/usr/bin/env python
# -*- coding:utf-8 -*-
if __name__ == "__main__" :
     echo "hello mimvp"
     print( "I love mimvp.com" )
```

Markdown 结果:

github-makedown-yu-fa-ru-men-09

 

5)Markdown 字体加粗

* 或 _,表示斜体

** 或 __,表示粗体

~~ 表示删除线

Markdown 语法:

1
2
3
4
5
6
7
8
9
Markdown 字体加粗
========
我爱 米扑科技  <br/>
我爱 *米扑科技*  (斜体) <br/>
我爱 _米扑科技_  (斜体) <br/>
我爱 **米扑科技**  (粗体) <br/>
我爱 __米扑科技__  (粗体) <br/>
我爱 ***米扑*科技**  (斜体 + 粗体) <br/>
我爱 ~~米扑科技~~  (删除线) <br/>

Markdown 结果:

github-makedown-yu-fa-ru-men-10

 

6)Markdown 无序列表

*(星号) +(加号) - (减号)表示无序列表

Markdown 语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Markdown 无序列表
========
*(星号)
--------
* 米扑科技
* 米扑代理
* 米扑域名
* 米扑财富
+(加号)
--------
+ 米扑科技
+ 米扑代理
+ 米扑域名
+ 米扑财富
-(减号)
--------
- 米扑科技
- 米扑代理
- 米扑域名
- 米扑财富

Markdown 结果:

github-makedown-yu-fa-ru-men-11

 

7)Markdown 有序列表

直接用1. xxx     2. xxx   3. xxx 编辑

Markdown 语法:

1
2
3
4
5
6
7
Markdown 有序列表
========
1. 米扑科技
2. 米扑代理
3. 米扑域名
4. 米扑财富

Markdown 结果:

github-makedown-yu-fa-ru-men-12

 

8)Markdown 插入链接

Markdown 插入链接,有两种方式:

方式1) [mimvp.com](http://mimvp.com)     

方式2)<a target="_blank" href="http://mimvp.com">mimvp.com</a>  (推荐

Markdown 语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
米扑科技
========
官网 [http: //mimvp .com](http: //mimvp .com)
官网 <a target= "_blank" href= "http://mimvp.com" >http: //mimvp .com< /a >
米扑代理
--------
官网 [http: //proxy .mimvp.com](http: //proxy .mimvp.com)
米扑域名
--------
官网 <a target= "_blank" href= "http://domain.mimvp.com" >http: //domain .mimvp.com< /a >
米扑财富
--------
官网 <a href= "http://money.mimvp.com" target= "_blank" >http: //money .mimvp.com< /a >

Markdown 结果:

github-makedown-yu-fa-ru-men-04

 

9)Markdown 插入图片

Markdown 插入图片有两种方式:

方式1) ![mimvp-logo.png](./mimvp-logo.png)

方式2) <img src="./mimvp-logo.png" title="mimvp-logo.png" />    

Markdown 语法:

1
2
3
4
5
6
7
8
9
Markdown 插入图片
========
### 1. 米扑科技(默认)
![mimvp-logo.png](. /mimvp-logo .png)
### 2. 米扑科技(img)
<img src= "./mimvp-logo.png" title= "mimvp-logo.png" />    

Markdown 结果:

github-makedown-yu-fa-ru-men-13

 

10)Markdown 表格

Makrdown 支持table表格,语法跟wiki类似。同时,也支持table标签

方式1

Markdown 语法:

1
2
3
4
5
6
7
8
Markdown 表格
========
|产品|网址|年份|
|----|-----|-----|
|米扑代理|[proxy.mimvp.com](http: //proxy .mimvp.com)|2014|
|米扑域名|[domain.mimvp.com](http: //domain .mimvp.com)|2015|
|米扑支付|[pay.mimvp.com](http: //pay .mimvp.com)|2016|
|米扑财富|[money.mimvp.com](http: //money .mimvp.com)|2017|

Markdown 结果:

github-makedown-yu-fa-ru-men-14

方式2

Markdown 语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<table>
< tr >
<td colspan= "3" color= "red" >米扑产品< /td >
< /tr >
< tr >
<td>米扑代理< /td >
<td>http: //proxy .mimvp.com< /td >
<td>2014< /td >
< /tr >
< tr >
<td>米扑域名< /td >
<td>http: //domain .mimvp.com< /td >
<td>2015< /td >
< /tr >
< tr >
<td>米扑支付< /td >
<td>http: //pay .mimvp.com< /td >
<td>2016< /td >
< /tr >
< tr >
<td>米扑财富< /td >
<td>http: //money .mimvp.com< /td >
<td>2017< /td >
< /tr >
< /table >

Markdown 结果:

github-makedown-yu-fa-ru-men-15

 

11)Markdown 多选项

多选项,结合了多种元素,如无序列表减号(-),方括号等

Markdown 语法:

1
2
3
4
5
6
7
8
9
Markdown 多选项
========
米扑产品包含?
- [x] 米扑代理
- [x] 米扑域名
- [x] 米扑支付
- [x] 米扑财富
- [ ] 米扑基金
- [ ] 米扑期货

Markdown 结果:

github-makedown-yu-fa-ru-men-16

 

12)Markdown emoji表情

 

Markdown 语法:

1
2
3
4
Markdown emoji
========
@mimvp is :+1: This PR looks great - I love mimvp.com  :smiley:

Markdown 结果:

github-makedown-yu-fa-ru-men-17

 

13)Markdown diff 高亮对比

diff 语法是代码高亮语法的一种,以 `+ `开头表示新增,`- `开头表示删除。

Markdown 语法:

1
2
3
4
5
6
Markdown diff 高亮对比
----------
``` diff
+ 增加 emoji.md
- 删除 emoji.txt
```

Markdown 结果:

github-makedown-yu-fa-ru-men-18

 

14)Markdown 其它知识

知识1:  [回到顶部](#readme)

知识2: 版本符号 &copy;

Markdown 语法:

1
2
3
4
5
Markdown 其它知识
----------
|`[回到顶部]( #readme)`|[回到顶部](#readme)|
|`版本符号 &copy;`|&copy;|

Markdown 结果:

github-makedown-yu-fa-ru-men-19

 

15)Markdown 版权格式

一般开源项目,末尾会追加一些开原作者的信息,例如米扑科技的作者信息如下,供参考。

Markdown 语法:

1
2
3
4
5
6
米扑科技
----------
<img src= "./mimvp-logo.png" title= "mimvp-logo.png" />
All Right &copy; [mimvp.com](http: //mimvp .com)   :blush:

Markdown 结果:

github-makedown-yu-fa-ru-men-20

 

本文Markdown示例,请见米扑科技的 GitHub:

https://github.com/mimvp/mimvp-markdown-syntax

 


这篇关于Github Makedown 语法入门的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/710277

相关文章

Python FastAPI入门安装使用

《PythonFastAPI入门安装使用》FastAPI是一个现代、快速的PythonWeb框架,用于构建API,它基于Python3.6+的类型提示特性,使得代码更加简洁且易于绶护,这篇文章主要介... 目录第一节:FastAPI入门一、FastAPI框架介绍什么是ASGI服务(WSGI)二、FastAP

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

数论入门整理(updating)

一、gcd lcm 基础中的基础,一般用来处理计算第一步什么的,分数化简之类。 LL gcd(LL a, LL b) { return b ? gcd(b, a % b) : a; } <pre name="code" class="cpp">LL lcm(LL a, LL b){LL c = gcd(a, b);return a / c * b;} 例题:

Java 创建图形用户界面(GUI)入门指南(Swing库 JFrame 类)概述

概述 基本概念 Java Swing 的架构 Java Swing 是一个为 Java 设计的 GUI 工具包,是 JAVA 基础类的一部分,基于 Java AWT 构建,提供了一系列轻量级、可定制的图形用户界面(GUI)组件。 与 AWT 相比,Swing 提供了许多比 AWT 更好的屏幕显示元素,更加灵活和可定制,具有更好的跨平台性能。 组件和容器 Java Swing 提供了许多

【IPV6从入门到起飞】5-1 IPV6+Home Assistant(搭建基本环境)

【IPV6从入门到起飞】5-1 IPV6+Home Assistant #搭建基本环境 1 背景2 docker下载 hass3 创建容器4 浏览器访问 hass5 手机APP远程访问hass6 更多玩法 1 背景 既然电脑可以IPV6入站,手机流量可以访问IPV6网络的服务,为什么不在电脑搭建Home Assistant(hass),来控制你的设备呢?@智能家居 @万物互联

poj 2104 and hdu 2665 划分树模板入门题

题意: 给一个数组n(1e5)个数,给一个范围(fr, to, k),求这个范围中第k大的数。 解析: 划分树入门。 bing神的模板。 坑爹的地方是把-l 看成了-1........ 一直re。 代码: poj 2104: #include <iostream>#include <cstdio>#include <cstdlib>#include <al

MySQL-CRUD入门1

文章目录 认识配置文件client节点mysql节点mysqld节点 数据的添加(Create)添加一行数据添加多行数据两种添加数据的效率对比 数据的查询(Retrieve)全列查询指定列查询查询中带有表达式关于字面量关于as重命名 临时表引入distinct去重order by 排序关于NULL 认识配置文件 在我们的MySQL服务安装好了之后, 会有一个配置文件, 也就

音视频入门基础:WAV专题(10)——FFmpeg源码中计算WAV音频文件每个packet的pts、dts的实现

一、引言 从文章《音视频入门基础:WAV专题(6)——通过FFprobe显示WAV音频文件每个数据包的信息》中我们可以知道,通过FFprobe命令可以打印WAV音频文件每个packet(也称为数据包或多媒体包)的信息,这些信息包含该packet的pts、dts: 打印出来的“pts”实际是AVPacket结构体中的成员变量pts,是以AVStream->time_base为单位的显

如何提高 GitHub 的下载速度

如何提高 GitHub 的下载速度 文章目录 如何提高 GitHub 的下载速度1. 注册账号2. 准备好链接3. 创建仓库4. 在码云上下载代码5. 仓库更新了怎么办 一般来说,国内的朋友从 GitHub 上面下载代码,速度最大是 20KB/s,这种龟速,谁能忍受呢? 本文介绍一种方法——利用“码云”,可以大大提高下载速度,亲测有效。 1. 注册账号 去“码云”注册一

C语言指针入门 《C语言非常道》

C语言指针入门 《C语言非常道》 作为一个程序员,我接触 C 语言有十年了。有的朋友让我推荐 C 语言的参考书,我不敢乱推荐,尤其是国内作者写的书,往往七拼八凑,漏洞百出。 但是,李忠老师的《C语言非常道》值得一读。对了,李老师有个官网,网址是: 李忠老师官网 最棒的是,有配套的教学视频,可以试看。 试看点这里 接下来言归正传,讲解指针。以下内容很多都参考了李忠老师的《C语言非