笔记规范

文档规范

文档目录

每个文件夹内必须有 README.md 文件, 并且必须包含以下内容

1. 使用 index: false 的 frontmatter 防止被索引包含
2. 使用一级标题表示的目录标题 (也可使用 frontmatter 中的 text 属性)
3. 使用 > 对目录下笔记来源进行说明
4. 使用 <AutoCatalog/> 组件生成自动目录

文档内容

1. 最好使用 frontmatter 的 order 属性确定索引顺序
2. 一个文档内最好只包含一个一级标题, 并以此标题作为文档名, 否则应使用 title 确定标题, 并且在 frontmatter 下使用 ---, 避免标题错误显示的 bug
3. 文档没有 Latex 格式错误与其他错误显示
4. 使用文档下的 src 文件夹保存图片素材, 对于自己绘制的素材, 最好使用 .drawio.svg 格式
5. 为了分类素材, 可在 src 文件夹中, 根据笔记名称建立同名的子文件夹
6. 文档链接优先使用 #, 避免使用 <div>
7. 尽量保证图片显示 ![]() 位于独立的一行中
8. 最好在图片的 [] 内填入图片描述
9. 当图片的大小过大时, 使用 ![](... =x400) 限制其高度, 保证更好的阅读体验; 多层图片则使其总高度不超过 400px

杂项

1. 对于一般的锚点, 可使用 [空行]{#[锚点名] .block_anchor} 设置, 通常放在需要锚点的块级元素上一行, 其中 block_anchor 定义于 .vuepress/styles/config.scss

代码规范

基本

参考此文档的要求

文档表示

• 对于代码块, 使用 ``` 包裹, 并写入正确的代码类型, 对于 C++, 类型为 cpp
• 对于行内代码, 使用 ` 包裹, 对于语法结构, 可选参数值均采用此方式包裹, 如 ${}, SEND_ERROR
• 保证行内代码使用到 <> 时, 使用 \ 转义

公式规范