玩转github之markdown的使用

Markdown

markdown是一个轻量化的标记语言,我们可以最小的输入,输出更好的内容,内容什么的也十分简洁明了常用于博客的使用,这里我们用十分钟的时间学习一下吧!

文本

换行

文本换行

使用空一行写或使用两次空格按回车键

段落换行

空一格按两次回车键

文本加粗

前后使用两个星号或使用两个下划线注意使用下划线时注意前后不要有文本,需要有空格(推荐使用星号)。

**文本加粗** 或 __文本加粗__  

文本斜体

前后使用一个星号或下划线。

*文本斜体* 或 _文本斜体     

删除线

前后两个波浪符。

~~删除线~~  

文本的下划线

在文本使用下划线,在新的一行上输入三个及以上星号或下划线注意后面不要加文字或使用三个及以上的减号(但要记得每个符号之间要使用空格不然会被视为其他意思)。

 ***
 ___
 - - - 

多级标题

井号加空格(最多到六级)

# 一级标题
## 二级标题
### 三级标题

列表

无序列表

在文本前加加号或减号或星号和空格(但不要混用,会被认为时不同列表会被明显隔开)

* 
- 
+ 

有序列表

数字加点和空格,记得还有如果需要列表有更小的列表,要空四格再写,依此类推。如果不想使用列表使用正常文本则在最后一个列表文本上使用两个空格再在新的一行写注意使用这种方式会发现他会按照最后一个列表对齐,推荐使用两次回车键

勾选框

打勾的方框

星号加空格再加空了格的方框再空格

* [ ]  
待勾方框

星号加空格再加方框里是x的方框再空格

* [x]   

代码块

多行代码块

  1. 代码前空四个,每行用ALT连续点击最后空四个或tap键
  2. 文本全选再使用tap键(这两种都需前后没有文本)
  3. 使用三个及以上的反引号前后包围,注意是在代码上下两行写(相比前两个更加简洁,且如果在开始的三个反引号后写明对应什么语言,在相应语法会有高亮)

单行代码块

代码前后一个反引号

引用文本

使用右尖尖加空格,如果需要退出文本使用一个空格加回车键,换行则是两个空格加回车键或每个前面都有右尖尖(推荐),注意引用支持嵌套。

>

超链接

单个超链接

一个方括号加小括号加空格

[需要有超链接的文本](网址)  

多个超链接

如果同时有多个超链接则可使用变量的方式 。

[需要有超链接的文本][a]
[a]: 网址

脚注

如果想要脚注这样的则需

[^数字]
[^数字]:注释

插入图片

在使用图片地址时推荐使用网络地址而不是本地地址可以使用诸如sm.ms等图片上传图层工具使用帮助转换。

![这里可写可不写,类似html的alt标签在网络不好时会显示所写文本](图片地址)

插入表格

语法如下

|名字|年龄|这是表头一般会自动高亮
|----|----|减号没有数量限制,最好和表头对齐美观
|文字|文字|  

如果需要居中等操作,则在第二行加相应冒号。
|:—|----|左对齐
|—😐----|右对齐
|:–😐----|居中

嵌入html格式

插入图片

例如图片如果不想使用已有格式的图片形式,也可使用html自定义。

#<img style="width: 300px;height: 500px" src="">  

换行

#<br>  

下划线

#<hr>  

文本操作

<span style="color:red;font-size: 40px">     

文本字体

    <font face=HEI>这里是黑体</font><font face=KAI>

markdown拓展语法

高亮

前后两个等号,高亮。

==高亮==  

上标

^数字^  

下标

~数字~

数学公式嵌入

单行数学标准格式

$公式$  

多行数学标准格式

$$
公式
$$  

###常用的数学表达
如果要用{}加\转义。

\sqrt[不写默认二根]{数字}  
\frac{分子}{分母} 分数表达式  
数字^数字 上标
数字_数字 下标
\not= 不等于
\approx 约等于
\leq  小于等于
\geq  大于等于
\pm 正负号
\times  乘
\div  除
\sum(可加上下标类如\sum^2)  求和
\prod 累乘
\coprod 累除
\overline{1+2+3}  平均数
\\  换行  
^\cric  度
\sin 数学格式的sin
\pi Π
\infty 无穷
\int  积分
\iint 三重积分
字母\prime 对字母求导
\lim 极限
\emptyset 空集
\in  集合属于
\notin  集合不属于
\supset  真包含
\superseteq  包含
\bigcap  交集
\bigcup  并集
\alpha
\beta
\gamma
\delta
\eta
\omega
\theta
\sigma
\mu
\epsilon
\rightarrow右箭头
\cdots位于中间的省略号
\ldots位于底部的省略号
$$
\begin{Bmatrix}
 a & b \\
 c & d
\end{Bmatrix}
$$
$$
\begin{CD}
 A @>a>> B \\
@VbVV @AAcA \\
 C @= D
\end{CD}
$$

img

Typora画流程图、时序图(顺序图)、甘特图

复制以下代码使用 typora 的源码模式粘贴到编辑器中查看效果:

img

以下几个实例效果图如下:

1、横向流程图源码格式:

​```mermaid
graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]
​```

2、竖向流程图源码格式:

​```mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]
​```

3、标准流程图源码格式:

​```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
​```

4、标准流程图源码格式(横向):

​```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
​```

5、UML时序图源码样例:

​```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗?
​```

6、UML时序图源码复杂样例:

​```mermaid
sequenceDiagram
Title: 标题:复杂使用
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象B->>小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->>对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
​```

7、UML标准时序图样例:

​```mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
​```

8、甘特图样例:

​```mermaid
%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h
​```

效果图如下:

img

Created with Raphaël 2.3.0 开始框 处理框 判断框(是或否?) 输入输出框 结束框 子流程 yes no
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值