所谓的.md文件,实际上就是markdown格式文本。因为在编写readme文档的时候需要使用这个格式进行编写,写devlog的时候也常使用.md转换成.rst格式然后进行编译,所以决定简单学习一下。
这里简单整理了一些markdown格式文本常用的格式符号的用法,包括标题,引用,代码块,表格,强调字体,删除下划线,转义符,以及脚注。
- 标题格式
标题格式如图。标题格式有好几种写法,
a. 第一种,用#键开头 空格 然后跟标题内容
前面带#号,后面带文字,分别表示h1-h6,上图可以看出,只到h6,而且h1下面会有一条横线,注意,#号后面有空格
a. 另一种表示方法如下
这种方法只能显示两级,再往下就是正文了。
a. 第三种表示方法:这个是闭合的符号
b. 两种方式可以混合使用,也就是说可以# 和====混合着写。它们都是转换成统一的html格式标签的。可以在写文档的时候随时观察预览效果
- 列表
列表分为有序列表和无序列表。
a. 有序列表是数字加点 后跟内容即可
a. 无序列表可以用“*”,“+”, “-”来作为格式符号。可以混合使用。预览图如下:
-
引用和代码块
如果想要标注出某段内容是引用摘抄等,可以添加引用格式符 >
如果想在其中插入代码块,则使用符号''' '''进行标记,其中三引号但独占一行。
-
分割线
有***** ___ ----------,至少三个,有空格也可以。
-
链接
有两种方式,行内式和参数式。
行内式的链接格式是:链接的文字放在[]中,链接地址放在随后的()中
参数式的格式是:方括号里放标题,冒号后面写链接地址
- 图片
图片也有两种表现方式,分别是行内式和参数式。和插入链接的方式几乎一样,只是在方括号前面加了一个!
其中,替代文本
:用于描述图片的文字,当图片无法显示时,会显示这段文本。
其中,图片链接
:指向图片的URL或本地路径。
如果你想插入一张网络上的图片,可以这样写:
如果你想插入一张存储在本地的图片,比如在同一目录下的 image.png
,可以这样写:
注意事项
- 确保图片链接有效,否则图片不会显示。
- 在本地使用时,确保文件路径正确。
- 表格
在Markdown中创建表格的基本格式如下:
| 列1 | 列2 | 列3 |
|-------|-------|-------|
| 行1-1 | 行1-2 | 行1-3 |
| 行2-1 | 行2-2 | 行2-3 |
说明
- 第一行是表头,用
|
分隔不同的列。 - 第二行使用
-
来定义每一列的对齐方式,至少要有三个-
。可以在:
的左边或右边添加空格来调整对齐::---
表示左对齐:---:
表示居中对齐---:
表示右对齐
示例
| 名字 | 年龄 | 职业 |
|--------|------|--------|
| 小明 | 25 | 教师 |
| 小红 | 22 | 学生 |
| 小刚 | 30 | 工程师 |
渲染效果
名字 | 年龄 | 职业 |
---|---|---|
小明 | 25 | 教师 |
小红 | 22 | 学生 |
小刚 | 30 | 工程师 |
通过这种方式,你可以轻松创建整齐的表格。
冒号得用英文的
- 强调转义删除线
在Markdown中,强调、转义和删除线的表示方式如下:
1. 强调
- 斜体:用单个星号或下划线包围文本。
- 示例:
*斜体*
或_斜体_
- 示例:
- 粗体:用两个星号或下划线包围文本。
- 示例:
**粗体**
或__粗体__
- 示例:
- 粗斜体:用三个星号或下划线包围文本。
- 示例:
***粗斜体***
或___粗斜体___
- 示例:
2. 转义
要在Markdown中插入特殊字符,可以使用反斜杠 \
进行转义。
- 示例:
\*转义的星号\*
会显示为*转义的星号*
(在前面只要加斜杠就可以显示原本的符号了
3. 删除线
使用两个波浪线包围文本。
- 示例:
~~删除线~~
- 下划线和脚注:
常见的基本都写在这里了。不常见的自己问chatgpt吧
标签:markdown,斜体,示例,转义,编写,格式,文本,下划线 From: https://www.cnblogs.com/sweetpotatoincorner/p/18518755