@(Markdown)[使用技巧|markdown]
主要内容
提示:在github中编写时应当注意,
>
每行末尾要加两个以上的空格,用于换行,同样适用于段落中换行。#
需要在后面加上一个空格才会生效。写参考式时,后一个[]
前不能有空格。
不适合gihub的语法:LaTex 公式、流程图。
Markdown是一种轻量级标记语言
, 它是以(简单、易懂的语言编译)文档形式,并以HTML的格式发布。
John Gruber于2004年与Aaron Swartz合作在语法上创建了Markdown语言,其目标是使人们“可以使用易于阅读和易于编写的纯文本格式书写,可选将其转换为结构上有效的XHTML(或HTML)”。(参见wiki百科)
因为它使用方便,没有过多的难点和权限,并且你还会很容易的上手。 在文本呈现上,整个文本看起来非常干净,重点和逻辑十分突出,有一种来自 幕布 的芳香。
这里就是markdown重要的语法。其中主要有 标题、段落、格式化、水平线、区块引用、代码块、标记、列表、链接、图片、反斜杠\
标题有两种格式:
1)使用 =
和 -
来修饰。
一级标题
=============================
二级标题
-----------------------------
效果如下:
2)使用#
修饰。
一级标题
#
二级标题
##
三级标题
###
四级标题
####
五级标题
#####
六级标题
######
效果如下:
段落的前后都需要空行,所谓空行就是没有内容的行。 如果想要段内强制换行,使用的方法是两个以上的空格加上回车。
格式化分为加粗
和斜体
,使用*
或_
修饰。
*斜体* 或 _斜体_
**加粗* *或 _加粗_
效果如下:
斜体 或 斜体
加粗 或 加粗
使用三个或以上的-
、*
或_
修饰。
------------------------------------------
****************************************
__________________________________
效果如下:
使用>
修饰。
>区块引用
>>嵌套区块引用
效果如下:
区块引用
嵌套区块引用
代码块的建立,需要每行前加Tab
、4个空格
或制表符
。
普通块:
void main() { printf("Hello,world"); }
代码块:
void main()
{
printf("Hello,world");
}
注意:需要和普通块区分空行
。
使用`` ` 进行修饰。
`标记`
效果如下:
标记
无序列表:使用.
、+\*
和-
修饰。
\ - ( + \ * ) 第一项
\ - ( + \ * ) 第二项
\ - ( + \ * ) 第三项
效果如下:
- 第一项
- 第二项
- 第三项
注意:符号前的空格确定项的等级,空格越多,等级越低。
有序列表:将上面的符号修改为数字
,并用.
进行修饰。
1. 第一项
2. 第二项
3. 第三项
效果如下:
- 第一项
- 第二项
- 第三项
** 注意**:标记后面至少有一个符号或制表符,如果不在区块内,则要用空行分开。
链接有两种形式,链接式和参考式。
链接式,如:
[Markdown](https:://github.com/younghz/Markdown "Markdown")
效果如下
参考式
[Markdown ] [1] [Markdown ] [2]
[1]: https://github.com/younghz/Markdown
[2]: https://github.com/younghz/Markdown
效果如下:
注意:[0]: https://github.com/younghz/Markdown
不出现在代码块中。
[]
后面不能有空格。
图片和链接使用方法类似,只是在之前加上一个!
。
它\
可以使Markdown语言中的符号,修改为普通符号,从而被显示出来。如:
符号显示:
写法如下:
\-
效果:
-
Markdown使用者:
- github
- 简书
- Apollo
- Stack Overflow
- 等等
其中包括:表格、公式、流程图、时序图
表格的使用(非traditonal markdown):
用|
表示表格纵向边界,表头和表内容用-
隔开,并可用:
进行对齐设置,两边都有:
则表示居中,若不加:
则默认左对齐。
代码库 | 链接 |
---|---|
MarkDown | https://github.com/younghz/Markdown |
MarkDownCopy | https://github.com/younghz/Markdown |
@requires_authorization
def somefunc(param1='', param2=0):
'''A docstring'''
if param1 > param2: # interesting
print 'Greater'
return (param2 - param1 + 1) or None
class SomeClass:
pass
>>> message = '''interpreter
... prompt'''
提示:该类使用于VS Code。参见使用Markdown输出LaTex数学公式。
可以创建行内公式,例如 $ \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N $。或者块级公式:
提示: 推荐了解 莱斯大学LaTex Math在线PDF手册。
Item | Value | Qty |
---|---|---|
Computer | 1600 USD | 5 |
Phone | 12 USD | 12 |
Pipe | 1 USD | 234 |
st=> start: Start
e=> end
op=> operation: My Operation
cond=> condition: Yes or No?
st-> op-> cond
cond(yes)-> e
cond(no)-> op
以及时序图:
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
使用 - [ ]
和 - [x]
语法可以创建复选框,实现 todo-list 等功能。例如:
- 已完成事项
- 待办事项1
- 待办事项2
注意:目前支持尚不完全,在印象笔记中勾选复选框是无效、不能同步的,所以必须在马克飞象中修改 Markdown 原文才可生效。下个版本将会全面支持。
Markdown作为一种标记语言
,它同样支持用HTML语言
。
- Markdown基本语法_作者:younghz
- 马克飞象