欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

markdown基础语法

程序员文章站 2022-06-15 19:28:13
...

从事前端后,不得不接触项目Readme来认识一个项目,而Readme用的语法是markdown,所以我专门写一篇来记录一下markdown一些常用语法,相当于做个笔记吧。

  • Markdown 是一种轻量级标记语言,能将文本换成有效的XHTML(或者HTML)文档,它的目标是实现易读易写,成为一种适用于网络的书写语言。
  • Markdown 语法简洁明了,易于掌握,所以用它来写作是件既效率又舒服的事情。

基础语法

标题

Markdown支持6种级别的标题,对应html标签 h1 ~ h6

# h1
## h2
### h3
#### h4
##### h5
###### h6
复制代码

效果如下:

h1

h2

h3

h4

h5
h6

除此之外标题语法还可用下划线标记语言来控制字体大小,缺点是存在大小限制

h1
---
h2
===
复制代码

区块段落引用

> 这是一个段落
复制代码

效果如下

这是一个段落

引用里面嵌套引用

> 最外层引用
> > 第二层 > 嵌套一层
> > > 多层嵌套
复制代码

最外层引用

第二层嵌套一层

多层嵌套

引用里嵌套代码块

> 外层
> ```
>  我是代码块
> ```
复制代码

文字删除效果

将待删除的文字用两个~符号包裹起来

~~被删除的文字~~
复制代码

效果如下

被删除的文字

插入链接or图片

[点击跳转百度](www.baidu.com "百度")
<https://www.baidu.com>
![图片名称](https://user-gold-cdn.xitu.io/2019/4/25/16a52555d557f16b?w=534&h=300&f=jpeg&s=21188)
复制代码

效果如下

点击跳转百度
www.baidu.com

图片链接前面要加个感叹号!

markdown同时支持部分html代码,如果你不喜欢用markdown的链接语法,你可以使用以下语法来生成一个链接

<a href="https://www.w3cschool.cn/">W3Cschool</a>
复制代码

W3Cschool

链接高级用法

用 1 作为网址变量:[google][1]
然后在文档的结尾为变量赋值(网址)
[1]: http://www.google.com/
复制代码

google

列表

支持有序列表和无序列表

  • 无序列表有*,-,+可标识
  • 有序列表为数字加. ,如1.
* 小明
* 小红
* 小芳

- 小明
- 小红
- 小芳

+ 小明
+ 小红
+ 小芳

1. 小明
2. 小红
3. 小芳
复制代码
  • 小明
  • 小红
  • 小芳
  1. 小明
  2. 小红
  3. 小芳

有序列表中是根据首个序号进行排列,后面的序号不影响排列

2. 小明
5. 小红
8. 小芳
复制代码

效果如下

  1. 小明
  2. 小红
  3. 小芳

组合使用

* 标题
    1. 内容
    2. 内容
    3. 内容
复制代码
  • 标题
    1. 内容
    2. 内容
    3. 内容

使用列表注意事项

如果一个列表项存在段落,需要一层换行

* 段落1

  段落2
复制代码
  • 段落1

    段落2

在段落里加入引用区块

* 标题
    >区块引用
复制代码
  • 标题

    区块引用

如果其他标签配合列表符出现问题时,可以尝试通过空格或制表符缩进来解决问题

换行

在需要换行的后面加两个空格,或者在换行中间加个反斜杠

第一行  (注意这行结尾要有两个空格)
第二行

第一行
\
第二行
复制代码

第一行
第二行

分割线

***
---
复制代码

效果如下



分隔线语法较为轻松,符号间可加空格

强调

通过强调符来使得文字变得更加显眼,如加粗or斜体

*斜体*
_斜体_

**粗体**
__粗体__

***斜粗体***
___斜粗体___
复制代码

斜体
斜体

粗体
粗体

斜粗体
斜粗体

插入代码块

通过三个反引号(`)的包裹或者四个空格缩进来插入代码块,并且制定一种语言

```javascript
这是一个代码块
```   0.0
复制代码
    代码块
    注意前面空格必须有四个或以上
复制代码

如果想使用行内代码块,只需要一个反引号包裹

这是一个行内代码块

插入表格

表头|条目一|条目二
:---:|:---:|:---:
项目|项目一|项目二
复制代码
表头 条目一 条目二
项目 项目一 项目二

第一行是表头,第二行是对齐方式,去掉右边的冒号为左对齐,右边同理,不加冒号默认居左,短斜杠数量可自定义, 第三行开始为表格内容

特殊符号处理

markdown中需要使用反斜杠(\)来转义语法中用到的特殊符号,主要有一下符号需要处理:

\   反斜线
`   反引号
*   星号
_   底线
{}  花括号
[]  方括号
()  括弧
#   井字号
+   加号
-   减号
.   英文句点
!   惊叹号
复制代码

在内容中输入以上特殊符号的时候一定要注意转义,否则将导致内容显示不全,甚至排版混乱

文字上色

markdown并没有给文字提供上色的符号,可通过编辑好的md文件并生成为html后手动添加颜色

掘金markdown快捷键

ctrl+h          h2标签
ctrl+k          链接
ctrl+l          行数定位
ctrl+b          加粗
ctrl+shift+i    插入图片
ctrl+shift+k    行内代码块
ctrl+shift+l    无序列表
ctrl+shift+c    插入代码块
复制代码

总结

markdown最终通过相应的编辑器或者脚本转换成html用于页面渲染,通过这些简单明了的字符就可以写出干净简洁的文章或博客 ,更多markdown语法参考Markdown官网。希望这篇文章能帮助到你,通过这篇文章开启我的掘金之旅!