基本语法规范
图片
不应引用网络图片。应在该 Markdown 文件的目录内建立 images
文件夹,将图片存入文件夹后使用相对链接引用。
markdown
错误:
正确:
链接规范
- 链接到仓库内其他文章的链接应使用相对引用。
- 链接中应使用
/
而非\
。 - 末尾不加文件扩展名(
.md
) 。 - 链接中的空格应当替换为
-
。
markdown
错误:[映射与函数](D:\LinhoNotes\高等数学\1 函数与极限\1.1 映射与函数.md)
正确:[映射与函数](../../高等数学/1-函数与极限/1.1-映射与函数)
HTML
如非必要,不应在 Markdown 中插入 HTML 代码(某些扩展语法除外
markdown
错误:
<div style="padding:10px;background-color:#fdd;border-left:6px solid #f44">
<strong>❗警告!</strong>
这是一个警告信息。
</div>
正确:
> [!caution]
>
> 这是一个警告信息。