Markdown是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML代码。以下是Markdown的基本语法和使用方案:
基本语法:
1. 标题
在文字前面加上#
来表示标题,#
的数量代表标题的级别。
# 一级标题
## 二级标题
### 三级标题
2. 段落
直接编写文字即可,段落之间用空行隔开。
3. 强调
- 斜体 或 斜体:将文字两边各加上一个
*
或_
- 粗体 或 粗体:将文字两边各加上两个
*
或_
- 粗斜体 或 粗斜体:将文字两边各加上三个
*
或_
4. 列表
- 无序列表:使用
*
、+
或-
后面跟上空格
- 列表项1
- 列表项2
- 有序列表:使用数字后面跟上英文句点和空格
1. 列表项1
2. 列表项2
5. 链接和图片
- 链接:
[链接文字](链接地址)
[百度](https://www.baidu.com)
- 图片:
![替代文字](图片地址)
![图片](https://example.com/image.jpg)
6. 引用
在引用的文字前加上>
即可。
> 这是引用的内容。
7. 代码
- 行内代码:使用一对反引号包围代码
code
- 代码块:使用三个反引号包围代码块,或四个空格缩进
code block
8. 表格
使用-
和|
来创建表格。
| 标题1 | 标题2 | 标题3 |
| --- | --- | --- |
| 内容1 | 内容2 | 内容3 |
使用方案:
- 文档编写:使用Markdown编写项目文档、笔记、博客等。
- 在线编辑器:许多在线编辑器(如Typora、StackEdit)支持Markdown语法,可以直接预览编辑效果。
- 论坛发帖:部分论坛支持Markdown语法,使用它可以更好地格式化帖子内容。
- 项目说明:在GitHub等代码托管平台上,项目README文件通常使用Markdown编写。
- 电子邮件:部分邮件客户端支持Markdown语法,可以用来格式化邮件内容。
掌握Markdown语法后,可以大大提高文本编辑的效率,使文档更加美观和结构化。
Markdown 的基本语法已经非常强大,但还有一些高级用法可以让文档更加丰富和灵活。以下是一些高级 Markdown 功能:
1. 目录(Table of Contents)
通过使用 [TOC]
标记,一些 Markdown 解析器可以自动生成文档的目录。
[TOC]
2. 定义列表
使用 :
来创建定义列表。
术语
: 定义描述
3. 注脚(Footnotes)
在文本中添加注脚,并在文档的底部提供注脚内容。
这是一个注脚的例子[^1]。
[^1]: 这是注脚的内容。
4. 删除线
使用 ~~
包围文字来添加删除线。
~~这是被删除的文字~~
5. 任务列表
在列表项前加上 [ ]
或 [x]
来创建勾选框。
- [ ] 任务一
- [x] 任务二
6. Emoji 表情
一些 Markdown 解析器支持直接使用 Emoji 代码。
:smile: :heart: :+1:
7. 数学公式
使用 LaTeX 语法来编写数学公式,通常需要额外的扩展或插件支持。
$$
e^{i\pi} + 1 = 0
$$
8. 流程图和时序图
使用 Mermaid 语法来创建流程图、时序图等,这同样需要额外的扩展或插件。
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
9. 自定义样式
通过内联 CSS 或 HTML 来自定义文本样式。
<p style="color: red;">这是红色文字</p>
10. HTML 元素
在 Markdown 中直接嵌入 HTML 元素,以实现更复杂的布局或样式。
<div style="border: 1px solid #ddd; padding: 10px;">
这是一个带边框和内边距的 div。
</div>
11. YAML 元数据
在文档顶部使用 YAML 格式的元数据,这在一些静态站点生成器(如 Jekyll)中很常见。
---
title: 文档标题
author: 作者名
date: 2023-04-01
---
12. 导入文件
一些 Markdown 解析器支持导入其他 Markdown 或代码文件。
{% include_relative file.md %}
这些高级用法可能需要特定的 Markdown 解析器或扩展来支持。在使用之前,最好查看你所使用的平台或工具的具体文档,以确认是否支持这些功能。