如何编辑

工具

mkdocs

功能

支持多语言、多版本。可在线或离线，可搜索，可多人协作编辑。可导出为Word或PDF等格式

安装

install python3.*
pip install mkdocs
pip install mkdocs-material
pip install pymdown-extensions
pip install python-markdown-math

此处为文档编辑示例

连接

1	`这是一个链接[mkdocs.org](https://www.mkdocs.org).`

这是一个链接mkdocs.org.

列表

- 项目1
- 项目2

项目1
项目2

强调

1	`我是注释或重要提醒`

我是注释或重要提醒

公式

行内公式：$ A=\sqrt{\frac{A}{B}}$

独立一行：
$$
A = \frac{\sqrt{2}}{2}
$$

行内公式： $A=\sqrt{\frac{A}{B}}$

独立一行： $A = \frac{\sqrt{2}}{2}$

加粗

1	`我显示的很粗`

我显示的很粗

画一条线

****

下划线

1	`<u>下划线</u>`

下划线

代码块

~~~~sql
SELECT * FROM Table;
~~~~

SELECT * FROM Table;

引用

1	`> 这是引用内容`

这是引用内容

Table

|       | Left | Right | Center |
| ----- | :---- | ----: | :------:|
| Item1 |   A   | :material-check:   D   | G |
| Item2 |   B   | :smile:   `E`   | H |
| Item3 |   C   |   F   | I |

	Left	Right	Center
Item1	A	:material-check: D	G
Item2	B	:smile: `E`	H
Item3	C	F	I

有序号的列表

 Item1
 Item2
 Item3

Item1
Item2
Item3

视频制作

工具

OBS Studio 录制视频

全局演示视频请设置Video - Base Reolution 和 Output Resolution为1080p(1920×1080)或720p(1280*720)
独立功能演示视频请设置Video - Base Reolution 和 Output Resolution为720p(1280*720)
可录制声音，但请不要录制视频无关的声音

Win10 Photos Video Editor 制作演示视频

Titile Card背景使用颜色(#2D7C9A)
所有文字颜色为白色，可根据实际情况调整
其他设置请保持默认设置不变（暂不清楚时候会根据不同系统有所不同）
导出时请保持与录制的视频一致的分辨率
如果同一段视频不允许添加多个文字，可以先Split再添加

Blocks

!!! note
    这里是一个Note，不是标准的Markdown,所以用Typora编辑可能不正确，可以用源代码模式编辑。
    使用!!! note, 后面的内容需要加缩进。如果是可以展开的，用???替换!!!,如果默认是打开的用???+
    其他类型包括note,abstract,summary,tldr,info,todo,tip,hint,important,success,check,done,
    question,help,faq,warning,caution,attention,failure,fail,missing,danger,error,bug,example,quote,cite

??? danger
    这里是一个Note，不是标准的Markdown,所以用Typora编辑可能不正确，可以用源代码模式编辑。
    使用!!! note, 后面的内容需要加缩进。如果是可以展开的，用???替换!!!,如果默认是打开的用???+
    其他类型包括note,abstract,summary,tldr,info,todo,tip,hint,important,success,check,done,
    question,help,faq,warning,caution,attention,failure,fail,missing,danger,error,bug,example,quote,cite

Note

这里是一个Note，不是标准的Markdown,所以用Typora编辑可能不正确，可以用源代码模式编辑。使用!!! note, 后面的内容需要加缩进。如果是可以展开的，用???替换!!!,如果默认是打开的用???+ 其他类型包括note,abstract,summary,tldr,info,todo,tip,hint,important,success,check,done, question,help,faq,warning,caution,attention,failure,fail,missing,danger,error,bug,example,quote,cite

Danger

这里是一个Note，不是标准的Markdown,所以用Typora编辑可能不正确，可以用源代码模式编辑。使用!!! note, 后面的内容需要加缩进。如果是可以展开的，用???替换!!!,如果默认是打开的用???+ 其他类型包括note,abstract,summary,tldr,info,todo,tip,hint,important,success,check,done, question,help,faq,warning,caution,attention,failure,fail,missing,danger,error,bug,example,quote,cite

引用标记

我引用了一个文档[^1]
[^1]: 我是被引用的文档

我引用了一个文档¹

Tooltips (Abbreviations)

在文本中显示一个临时的ToolTip

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium

The HTML specification is maintained by the W3C.

定义列表（Definition Lists）

`Lorem ipsum dolor sit amet`
:   Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
    tellus non sem sollicitudin, quis rutrum leo facilisis.

`Cras arcu libero`
:   Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
    ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

    Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    Nam vulputate tincidunt fringilla.
    Nullam dignissim ultrices urna non auctor.

Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus tellus non sem sollicitudin, quis rutrum leo facilisis.

Cras arcu libero

Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis. Nam vulputate tincidunt fringilla. Nullam dignissim ultrices urna non auctor.

带CheckBox的列表（Task Lists）

- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
- [ ] Vestibulum convallis sit amet nisi a tincidunt
    * [x] In hac habitasse platea dictumst
    * [x] In scelerisque nibh non dolor mollis congue sed et metus
    * [ ] Praesent sed risus massa
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Lorem ipsum dolor sit amet, consectetur adipiscing elit
Vestibulum convallis sit amet nisi a tincidunt
- In hac habitasse platea dictumst
- In scelerisque nibh non dolor mollis congue sed et metus
- Praesent sed risus massa
Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Tabs

=== "曲线"
    用直线将数据点连接起来。

=== "阶梯"
    曲线在下一点到达前保持不变，曲线呈阶梯状。

=== "棒"
    以2DBar的方式显示数据。

曲线

用直线将数据点连接起来。

阶梯

曲线在下一点到达前保持不变，曲线呈阶梯状。

棒

以2DBar的方式显示数据。

编辑工具及参考

Markdown编辑工具：
- Typora : 注意将缩进改为4个空格
- Notepad++
- VSCode
视频录制编辑:
- OBSStudio: 录制视频
- ClickShow: 鼠标点击时显示圆圈
- ScreenToGif: 录制gif，会自动加入鼠标点击效果
- Win10 Photos Video Editor ：视频编辑，插入文本
数学公式:
- markdown中公式编辑教程
- Markdown数学公式语法

我是被引用的文档，不管我写在哪里，都将显示在下面 ↩