<!--
title: 注意事项 
sort: 5
-->

⚠️  在使用文档生成工具是，应注意一些事项，避免生成文档过程出现错误。

1. 文件与文件夹不能重名。
2. 顶部菜单通过 `sort` 排序是无效的。
5. HTML 中写 `<script>` 记得中间空一行哦。
6. 首页文件名 `README.md`，没有做处理，必须保持跟它一模一样。
3. Markdown 语法支持`\`转义，使用请谨慎。
4. Markdown 内部支持HTML代码运行。
5. Markdown 文档中插入图片，只能相对路径，并且在指定的目录内，相对于指定目录路径，[详细参考](#/introduce/guides/insert-img)。
6. Markdown 文档中插入图片资源目录不能重复。
6. Markdown 语法外面嵌套 HTML 标签，HTML标签将不起作用。
