GitHub上README.md简单教程

2017-05-25 本文已影响0人 id_confidence

最近对它的README.md文件颇为感兴趣。便写下这简书，希望帮助更多的还不会编写README文件的同学们。
README文件后缀名为md。md是markdown的缩写，markdown是一种编辑博客的语言。

Markdown 语法简单用法

标题

大标题  
=======

小标题

' #'+汉字组成各级标题，中间要空格

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

eg:
#一级标题  
##二级标题  
###三级标题  
####四级标题  
#####五级标题  
######六级标题

注释：大标题和小标题分别对应一、二级标题

3.下分割线

文字
“-------”

4 . 超链接

Markdown

示例：
- [Markdown](https://www.jianshu.com/p/9349ebcb14a6)

5 . 插入符号
一. 圆点符

昵称：果冻虾仁
别名：隔壁老王
英文名：Jelly

eg:
* 昵称：果冻虾仁  
* 别名：隔壁老王  
* 英文名：Jelly

二. 二级圆点三级圆点前多加tab

昵称：果冻虾仁
- 别名：隔壁老王
  - 英文名：Jelly

eg:
* 昵称：果冻虾仁  
  * 别名：隔壁老王  
    * 英文名：Jelly

6 .缩进

地球🌍

亚洲🌏

中国 🇨🇳

深圳

eg:
>地球🌍
>>亚洲🌏
>>>中国  🇨🇳
>>>>深圳

7 . 图片+文字说明（gif和普通图片相同）

![图片alt](图片地址 ''图片title'')

图片alt就是显示在图片下面的文字，相当于对图片内容的解释。
图片title是图片的标题，当鼠标移到图片上时显示的内容。title可加可不加

小黄鸡

[图片上传失败...(image-dfbb00-1564209815628)]

eg:
![小黄鸡](https://img.haomeiwen.com/i4673907/2074192aa737527d.gif?imageMogr2/auto-orient/strip)

![美景](http://img2.imgtn.bdimg.com/it/u=708621475,197951563&fm=23&gp=0.jpg)

8 . 代码引用
中国人
self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];

eg:
`中国人 `
`self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];`

9 . 文字引用

一盏灯，一片昏黄；一简书，一杯淡茶。守着那一份淡定，品读属于自己的寂寞。保持淡定，才能欣赏到最美丽的风景！保持淡定，人生从此不再寂寞。

eg:文字前加>
一盏灯， 一片昏黄； 一简书， 一杯淡茶。 守着那一份淡定， 品读属于自己的寂寞。 保持淡定， 才能欣赏到最美丽的风景！ 保持淡定， 人生从此不再寂寞。

10 . 表格

星期	车次	时间
星期一	G1008	4:30
星期二	G1006	14:55
星期三	G1007	18:30
星期四	G1009	21:30

eg:  “---------”左右两边的“：”决定文字的对齐方式
| 星期        | 车次           | 时间  |
| ------------- |:-------------:| -----:|
| 星期一      |G1008 | 4:30 |
|  星期二  | G1006      |  14:55 |
|  星期三   | G1007    |   18:30 |

Markdown 语法和 MWeb 写作使用说明

效果如下：

[TOC]

Markdown 的设计哲学

Markdown 的目標是實現「易讀易寫」。
不過最需要強調的便是它的可讀性。一份使用 Markdown 格式撰寫的文件應該可以直接以純文字發佈，並且看起來不會像是由許多標籤或是格式指令所構成。
Markdown 的語法有個主要的目的：用來作為一種網路內容的寫作用語言。

本文约定

如果有写 效果如下：，在 MWeb 编辑状态下只有用 CMD + 4 或 CMD + R 预览才可以看效果。

标题

Markdown 语法：

# 第一级标题 `<h1>` 
## 第二级标题 `<h2>` 
###### 第六级标题 `<h6>`

效果如下：

第一级标题 `<h1>`

第二级标题 `<h2>`

第六级标题 `<h6>`

强调

Markdown 语法：

*这些文字会生成`<em>`*
_这些文字会生成`<u>`_

**这些文字会生成`<strong>`**
__这些文字会生成`<strong>`__

在 MWeb 中的快捷键为： CMD + U、CMD + I、CMD + B
效果如下：

这些文字会生成<em>
这些文字会生成<u>

这些文字会生成<strong>
这些文字会生成<strong>

换行

四个及以上空格加回车。
如果不想打这么多空格，只要回车就为换行，请勾选：Preferences - Themes - Translate newlines to <br> tags

列表

无序列表

Markdown 语法：

* 项目一 无序列表 `* + 空格键`
* 项目二
* 项目二的子项目一 无序列表 `TAB + * + 空格键`
* 项目二的子项目二

在 MWeb 中的快捷键为： Option + U
效果如下：

项目一无序列表 * + 空格键
项目二
项目二的子项目一无序列表 TAB + * + 空格键
项目二的子项目二

有序列表

Markdown 语法：

1. 项目一 有序列表 `数字 + . + 空格键`
2. 项目二 
3. 项目三
1. 项目三的子项目一 有序列表 `TAB + 数字 + . + 空格键`
2. 项目三的子项目二

效果如下：

项目一有序列表 数字 + . + 空格键
项目二
项目三
项目三的子项目一有序列表 TAB + 数字 + . + 空格键
项目三的子项目二

任务列表（Task lists）

Markdown 语法：

- [ ] 任务一 未做任务 `- + 空格 + [ ]`
- [x] 任务二 已做任务 `- + 空格 + [x]`

效果如下：

[ ] 任务一未做任务 - + 空格 + [ ]
[x] 任务二已做任务 - + 空格 + [x]

图片

Markdown 语法：

![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)
格式: ![Alt Text](url)

Control + Shift + I 可插入Markdown语法。
如果是 MWeb 的文档库中的文档，还可以用拖放图片、CMD + V 粘贴、CMD + Option + I 导入这三种方式来增加图片。
效果如下：

[站外图片上传中...(image-1f771f-1550542906397)]

MWeb 引入的特别的语法来设置图片宽度，方法是在图片描述后加 -w + 图片宽度 即可，比如说要设置上面的图片的宽度为 140，语法如下：

[站外图片上传中...(image-c97dea-1550542906397)]

链接

Markdown 语法：

email <example@example.com>
[GitHub](http://github.com)
自动生成连接  <http://www.github.com/>

Control + Shift + L 可插入Markdown语法。
如果是 MWeb 的文档库中的文档，拖放或CMD + Option + I 导入非图片时，会生成连接。
效果如下：

Email 连接： example@example.com
连接标题Github网站
自动生成连接像： http://www.github.com/ 这样

区块引用

Markdown 语法：

某某说:
> 第一行引用
> 第二行费用文字

CMD + Shift + B 可插入Markdown语法。
效果如下：

某某说:

第一行引用
第二行费用文字

行内代码

Markdown 语法：

像这样即可：`<addr>` `code`

CMD + K 可插入Markdown语法。
效果如下：

像这样即可：<addr> code

多行或者一段代码

Markdown 语法：

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

}
```

CMD + Shift + K 可插入Markdown语法。
效果如下：

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

}

顺序图或流程图

Markdown 语法：

```sequence
张三->李四: 嘿，小四儿, 写博客了没?
Note right of 李四: 李四愣了一下，说：
李四-->张三: 忙得吐血，哪有时间写。
```

```flow
st=>start: 开始
e=>end: 结束
op=>operation: 我的操作
cond=>condition: 确认？

st->op->cond
cond(yes)->e
cond(no)->op
```

效果如下（ Preferences - Themes - Enable sequence & flow chart 才会看到效果）：

张三->李四: 嘿，小四儿, 写博客了没?
Note right of 李四: 李四愣了一下，说：
李四-->张三: 忙得吐血，哪有时间写。

st=>start: 开始
e=>end: 结束
op=>operation: 我的操作
cond=>condition: 确认？

st->op->cond
cond(yes)->e
cond(no)->op

表格

Markdown 语法：

第一格表头 | 第二格表头
--------- | -------------
内容单元格 第一列第一格 | 内容单元格第二列第一格
内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格

效果如下：

第一格表头	第二格表头
内容单元格第一列第一格	内容单元格第二列第一格
内容单元格第一列第二格多加文字	内容单元格第二列第二格

删除线

Markdown 语法：

加删除线像这样用： ~~删除这些~~

效果如下：

加删除线像这样用： ~~删除这些~~

分隔线

以下三种方式都可以生成分隔线：

效果如下：

MathJax

Markdown 语法：

块级公式：
$$  x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

\\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \\]

行内公式： $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

效果如下（Preferences - Themes - Enable MathJax 才会看到效果）：

块级公式：
$x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}$

\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \]

行内公式： $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

脚注（Footnote）

Markdown 语法：

这是一个脚注：[^sample_footnote]

效果如下：

这是一个脚注：^[1]

这里是脚注信息 ↩

GitHub上README.md简单教程

Markdown 语法简单用法

小标题

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

注释：大标题和小标题分别对应一、二级标题

Markdown 语法和 MWeb 写作使用说明

Markdown 的设计哲学

本文约定

标题

第一级标题 `<h1>`

第二级标题 `<h2>`

第六级标题 `<h6>`

强调

换行

列表

无序列表

有序列表

任务列表（Task lists）

图片

链接

区块引用

行内代码

多行或者一段代码

顺序图或流程图

表格

删除线

分隔线

MathJax

脚注（Footnote）

猜你喜欢

热点阅读

GitHub上README.md简单教程

Markdown 语法简单用法

小标题

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

注释：大标题和小标题分别对应一、二级标题

Markdown 语法和 MWeb 写作使用说明

Markdown 的设计哲学

本文约定

标题

第一级标题 <h1>

第二级标题 <h2>

第六级标题 <h6>

强调

换行

列表

无序列表

有序列表

任务列表（Task lists）

图片

链接

区块引用

行内代码

多行或者一段代码

顺序图或流程图

表格

删除线

分隔线

MathJax

脚注（Footnote）

猜你喜欢

热点阅读

第一级标题 `<h1>`

第二级标题 `<h2>`

第六级标题 `<h6>`