最近开始试着学习使用Typora写文档记录东西,这篇放一些常用的Markdown使用例以便回顾,并分享给大家
Markdown是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML(超文本标记语言)文档。Markdown的语法简单直观,目的是为了让非技术人员也能快速上手,用简单的符号和指令来添加如标题、列表、链接、图片等元素。
通常来说了解 Markdown 格式化语法的最佳方式除了阅读相关语法介绍以外,还有用.txt后缀打开.md文档查看 Markdown 格式的文档相应语法
#
:Markdown 支持六级标题,这些标题是通过在文本前添加不同数量的 # 符号来定义的。具体如下:
# 一级标题
// 等价于等价于html语法里的<h1>一级标题<h1>
## 二级标题
### 三级标题
效果演示
一级标题通常是最主要的标题,其字体大小最大,而六级标题是最小的子标题,字体大小最小。在实际应用中,根据文档结构的需要,不一定需要使用所有六级标题,但了解它们的存在有助于更好地组织文档。
关于 # 的使用,需要注意的是,在每个 # 后面应该至少跟一个空格,否则 Markdown 解析器可能无法正确识别标题。此外,尽管理论上可以使用更多的 # 符号,但是大多数 Markdown 解析器只支持六级标题,超过六个 # 的使用通常不会产生额外的效果。
加粗,通常在文本的前后各添加两个星号(**)或下划线(__)
斜体是一个星号或下划线
斜体加粗是三个星号或下划线
*斜体* _斜体_
**加粗** __加粗__
***斜体加粗*** ___斜体加粗___
斜体
加粗
斜体加粗
Markdown 应用程序在处理单词或短语中间添加的下划线上并不一致。为了实现兼容性,通常建议使用星号将单词或短语的中间部分加粗并以斜体显示,以示重要。
删除线通常在文本的两侧加两个~~
示例:
~~我是地平论支持者(不是)~~
我是地平论支持者(不是)
要创建块引用,在段落前添加一个 > 符号,引用也可以嵌套,如加两个>>三个>>> n个>>>>.....
>这是一段引用
>>这是二段引用
>>>这是三段引用
>>>>>>>>>>这是十段引用
块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用,需要进行测试以查看哪些元素有效。
>## 你好
>
>- 列表1
>- 列表2
>
> **加粗**
要创建有序列表,每个列表项前添加数字并紧跟一个英文句点. 数字不必按数学顺序排列,但是列表应当以数字 1 起始。
要创建无序列表,每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。
有序列表:
1. 打游戏
2. 学习
3. 睡觉
无序列表:
- 无序
- 啊啊
- 对对对
* 不对不对
列表结合其它语法演示:
- **摆烂**
- [ ] 跑步
- [ ] 思考人生
单行代码:代码左右两边用反引号包起来
hello word
代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行,并且提供代码语言,如果代码语言异常,或主流的代码高亮插件无法识别会导致其无法高亮显示
如果使用的是不能高亮的代码语言,为了高亮显示可以试着将代码语言标注为Javascript 并在别的地方提示读者代码语言是什么。
`单行代码`:
```cpp
int main(){
return 0;
}
```
通常第一行放表头既标题,第二行通常使用三个或多个连字符(---)分割表头和内容。
其实-有一个就行,但是为了对齐或兼容,可以多加几个。
-的左边加:表示标题和内容居左(不加:默认居左)
-的两边加:表示标题和内容居中
-的右边加:表示标题和内容居右
两边可以用 | 包起来也可以不用|包起来,根据md解释器的不同要求不同
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
表格:
姓名|年龄|成绩
:--|--:|:--:
张三|19|99
其中一个效果如下所示:
姓名 | 年龄 | 成绩 |
---|---|---|
张三 | 19 | 99 |
三个或者更多的---和***随便放在空的一行即可形成分割线
***
---
---------
*******************
效果如下所示
Markdown处理器会自动将URL转换为链接。例如直接输入http://www.baidu.com,Markdown处理器会自动将其转换为链接,如果不想自动转为连接可以通过在连接的两边加[]或者``之类的。
url链接的格式为 [链接文本](链接地址 "链接标题")
示例:
[我的个人空间](https://cloud.tencent.com/developer/user/10787455 "个人空间")
链接标题可加可不加
访问 我的个人空间
链接标题是鼠标移到链接旁边时会显示的文字,有的md解释器支持,有的不支持
几个使用例
[腾讯云开发者社区](https://cloud.tencent.com/developer "腾讯云开发者社区")
[Link Text](https://cloud.tencent.com/developer "Link Title")
ULR:
https://cloud.tencent.com/developer
ULR:
https://cloud.tencent.com/developer
图片通常由以下三元素组成
图片文本
是当图片无法显示时显示的文字描述,这对于提高网页的可访问性非常重要。
在图片能显示时,通常位于图片下面居中位置
图片链接
也可以说是 图片路径
通常可以是相对路径或者绝对URL。在本地文件系统中使用相对路径时,路径应相对于Markdown文件的位置。如果图片或链接位于同一目录下,可以直接使用文件名。
图片标题
是指鼠标移动到图片旁边时会跳出来的文字,类似与url的url标题,同理有的md解释器支持有的不支持
![图片文本](图片链接 ''图片title'')
而一个图片开头的!
感叹号很重要,它是与url连接做区分用的
示例:
![蔚蓝档案](https://webcnstatic.yostar.net/ba_cn_web/prod/web/assets/LOGO.4a06cdd2.png "蔚蓝档案")
Markdown的目的是尽可能地易于阅读和易写。
但是,可读性是最重要的。标记格式的文档应该是可以按原样发布的,即纯文本,而不会看起来像用标记或格式说明进行了标记。Markdown的语法受到了几个现有的文本到html过滤器的影响——包括Setext、atx、Textile、reStructuredText、Grutatext和EtText——Markdown语法最大的灵感来源是纯文本电子邮件的格式。
为此,Markdown的语法完全由标点符号组成,这些标点符号经过精心挑选,看起来像它们的意思。例如,文字周围的星号实际上看起来像强调它(加粗)。一个列表看起来就像,嗯,列表。
另外md格式里也支持html格式,如果有用md语法展示不出来的效果,可以试着切换成html的语法。
不同的md解释器能支持的md语法也不同,例如本文未介绍的脚注和数学公式等等,故本文跳过。
本文是总结以前的md学习笔记和参考Markdown 官方教程网站所写,如有谬误尽情指出
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。