Skip to content

FE-Acmen/Markdown-grammar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 

Repository files navigation

Markdown-基本语法

目录

1.分级标题

两种形式:

  • 使用'-'和'='标记一级二级标题

    一级标题
    '======='
    二级标题
    '-------'

    效果:

    一级标题

    二级标题

  • 使用'#',表示1-6级标题

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

    效果:

    一级标题

    二级标题

    三级标题

    四级标题

    五级标题
    六级标题

2.斜体粗体

*斜体*,_斜体_
**粗体**,__粗体__
***加粗斜线***
~~删除线~~

效果:

斜体斜体
粗体粗体
加粗斜线
删除线

3.超链接

Markdown 支持两种形式的链接语法: 行内式和参考式两种形式,行内式一般使用较多。

  • 行内式
    语法:[]里写链接文字,()里写链接地址, ()中的“”中可以为链接指定title属性,title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字。链接地址与链接标题前有一个空格。

    欢迎star[Markdown-grammar](https://github.com/Young0510/Markdown-grammar\)
    欢迎star[Markdown-grammar](https://github.com/Young0510/Markdown-grammar "Markdown-grammar")

    效果:

    欢迎starMarkdown-grammar
    欢迎starMarkdown-grammar

  • 参考式
    语法:参考式链接分为两部分,文中的写法 [链接文字][链接标记],在文本的任意位置添加[链接标记]:链接地址 “链接标题”,链接地址与链接标题前有一个空格。

    如果链接文字本身可以做为链接标记,你也可以写成[链接文字][] [链接文字]:链接地址的形式,见代码的最后一行。

    欢迎关注我的[知乎][1],[掘金][2],[stackoverflow][3],[github][]
    [1]:https:://www.zhihu.com/people/zhang-liu-ping-55
    [2]:https:://juejin.im/user/5c1780926fb9a049ca37436c
    [3]:https:://stackoverflow.com/users/10556742/liuping-zhang
    [github]:https:://github.com/Young0510

    效果:

    欢迎关注我的知乎掘金stackoverflowgithub

    注意:上述的[1]:https://www.zhihu.com/people/zhang-liu-ping-55不出现在区块中。

  • 自动链接

    <http://baidu.com>
    <[email protected]>

    效果:

    http://baidu.com
    [email protected]

4.区块引用

语法:引用需要在被引用的文本前加上'>'符号

> 这是一段引用

> 这是多行引用
> 引用文字1
> 引用文字2

效果:

这是一段引用

这是多行引用
引用文字1
引用文字2

  • 引用的多层嵌套
    语法:区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的'>'

    >请问如何学习前端?
    >>看书
    >>>看视频

    效果:

    请问如何学习前端?

    看书

    看视频

  • 引用其他要素
    引用的区块内也可以使用其他Markdown语法,包括标题、列表、代码区块等

    > 1. 这是第一行
    > 2. 这是第二行
    > 代码例子:
    >print("hello world!")

    效果:

    1. 这是第一行
    2. 这是第二行
      代码例子:
      print("hello world!")

5.锚点

Github 并不支持 HTML 形式的锚点链接,它有自己的规则

  • 任意 1-6 个 # 标注的标题都会被添加上同名的锚点链接

    [标题1](#标题1)
    [标题2](#标题2)
    [标题3](#标题3)

    # 标题1
    ## 标题2
    ### 标题3

    效果:

    标题1
    标题2
    标题3

    标题1

    标题2

    标题3

  • 锚点跳转的标识名称,可使用任意字符,大写字母要转换成小写

    [Github标题1](#github标题1)
    ### Github标题1

    效果:

    Github

    Github标题1

  • 多单词锚点的空格用 - 代替

    [Github 标题2 Test](#github-标题2-test)
    ### Github 标题2 Test

    效果:

    Github 标题2 Test

    Github 标题2 Test

  • 多级序号需要去除

    [2.3. Github 标题](#23-github-标题)
    ### 2.3. Github 标题

    效果:

    2.3. Github 标题

    2.3. Github 标题

注意:非英文的锚点字符,在单击跳转时,在浏览器的 url 中会按照规则进行 encode 和 decode

6.插入图像

图片的创建方式与超链接相似,而且和超链接一样也有两种写法,行内式和参考式写法。这里只展示行内式一种写法,参考式可以根据超链接的语法推导出来,就不再复述。
语法:在文档要插入图片的地方写![图片Alt](图片URL "title"),图片Alt的意思是如果图片因为某些原因不能显示,就用定义的图片Alt文字来代替图片,图片Alt和title都可以省略,但建议写上

我的Github:
![zhanglp的Github](/Capture1.PNG "我的Github")

效果:
我的Github:
zhanglp的Github

7.注脚

语法:
脚注是在需要标记脚注文字的后面增加一个方括号,方括号中的内容必须以 ^ 开头,再接着是数字、字符串标记,在文件的任意地方,你可以把这个脚注的内容定义出来

注意:注脚与注脚之间必须空一行,不然会失效。成功后会发现,即使你没有把注脚写在文末,经Markdown转换后,也会自动归类到文章的最后。

使用Markdown[^1]可以效率的书写文档,直接转换成HTML[^2]。

[^1]Markdown是一种纯文本标记语言

[^2]HyperText Markup Language 超文本标记语言

效果:
使用Markdown1可以效率的书写文档,直接转换成HTML2

8.分隔线

你可以在一行中用三个以上的星号(*)、减号(-)、底线(_)来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格

* * *
***
- - -
------------

效果:





9.代码

对于程序员来说这个功能是必不可少的,插入程序代码的方式有两种,一种是利用缩进(Tab), 另一种是利用”`”符号(一般在ESC键下方)包裹代码。

语法:

  • 插入行内代码,即插入一个单词或者一句代码的情况,使用code这样的形式插入。
  • 插入多行代码,可以使用缩进或者“ code “,具体看示例。
    注意:缩进式插入前方必须有空行
  • 行内式

Javascript语言里的函数`function()`怎么使用?

效果:

Javascript语言里的函数function()怎么使用?

  • 缩进式多行代码
    语法:缩进4个空格或是1个制表符
    一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)

     function(){
     alert("Hello,world")
     }

效果:

function(){
    alert("Hello,world")
}   
  • 用六个`包裹多行代码

```
function(){
alert("Hello,world")
}
```

效果:

function(){
    alert("Hello,world")
}  
  • HTML原始码
    在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Mark down 插入范例用的 HTML 原始码,只需要复制贴上,剩下的 Markdown 都会帮你处理
<div class="footer">
   © 2018 Young  
</div>  

效果:

© 2018 Young

10.列表

  • 无序列表
    使用*,+,-表示无序列表

    - 无序列表项1  
    - 无序列表项2  
    - 无序列表项3  
    

    效果:

    • 无序列表项1
    • 无序列表项2
    • 无序列表项3
  • 有序列表
    有序列表则使用数字接着一个英文句点

    1. 有序列表项1  
    2. 有序列表项2  
    3. 有序列表项3  
    

    效果:

    1. 有序列表项1
    2. 有序列表项2
    3. 有序列表项3
  • 定义型列表
    定义型列表由名词和解释组成。一行写上定义,紧跟一行写上解释。解释的写法:紧跟一个缩进(Tab)

    代码块 1 Markdown  
    :    轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)  
    
    代码块 2  
    :    这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)  
    

    效果:

    代码块 1 Markdown
    : 轻量级文本标记语言,可以转换成html,pdf等格式(左侧有一个可见的冒号和四个不可见的空格)

    代码块 2
    : 这是代码块的定义(左侧有一个可见的冒号和四个不可见的空格)

  • 列表缩进

            代码块(左侧有八个不可见的空格)  
    

    效果:

        代码块(左侧有八个不可见的空格)  
    
  • 包含段落的列表
    列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符(显示效果与代码一致)

    *    轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
    *    那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 但我不能放歌,悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥!
    

    效果:

    • 轻轻的我走了, 正如我轻轻的来; 我轻轻的招手, 作别西天的云彩。那河畔的金柳, 是夕阳中的新娘; 波光里的艳影, 在我的心头荡漾。 软泥上的青荇, 油油的在水底招摇; 在康河的柔波里, 我甘心做一条水草!
    • 那榆荫下的一潭, 不是清泉, 是天上虹; 揉碎在浮藻间, 沉淀着彩虹似的梦。 寻梦?撑一支长篙, 向青草更青处漫溯; 满载一船星辉, 在星辉斑斓里放歌。 但我不能放歌, 悄悄是别离的笙箫; 夏虫也为我沉默, 沉默是今晚的康桥!
  • 包含引用的列表
    如果要在列表项目内放进引用,那 > 就需要缩进

    *    阅读的方法:  
         > 打开书本  
         > 打开台灯  
    

    效果:

    • 阅读的方法:

      打开书本
      打开台灯

  • 包含代码区块的引用
    如果要放代码区块的话,该区块就需要缩进两次,也就是 8 个空格或是 2 个制表符

  • 一个特殊情况
    在特殊情况下,项目列表很可能会不小心产生,像是下面这样的写法

    1996\. Who are you?  
    

    效果:

    1. Who are you?

    换句话说,也就是在行首出现数字-句点-空白,要避免这样的状况,你可以在句点前面加上反斜杠

11.表格

不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行为一个表格行。 列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。 第二行还可以为不同的列指定对齐方向。默认为左对齐,在-右边加上:就右对齐

  • 简单方式写表格

    学号|姓名|分数  
    -|-|-  
    1|小明|66  
    2|小红|77  
    3|小李|88  
    

    效果:

    学号 姓名 分数
    1 小明 66
    2 小红 77
    3 小李 88
  • 原生方式写表格

    |学号|姓名|分数|  
    |-|-|-|  
    |1|小明|66|
    |2|小红|77|  
    |3|小李|88|  
    

    效果:

    学号 姓名 分数
    1 小明 66
    2 小红 77
    3 小李 88
  • 为表格第二列指定方向

    产品|价格  
    -|-:  
    1password 普通会员|20元/年  
    1password 高级会员|88元/年  
    

    效果:

    产品 价格
    1password 普通会员 20元/年
    1password 高级会员 88元/年

Footnotes

  1. Markdown是一种纯文本标记语言

  2. HyperTextMarkup Language 超文本标记语言

Releases

No releases published

Packages

No packages published