书写规范
为了保持维基的整体性,本维基定义/使用了以下书写规范。
命名规范
- .md文件使用英文命名,多个单词之间使用连字符'-'连接。
排版约束
- 文本格式: 本维基所有内容全部使用Markdown格式进行书写,如果你不了解Markdown,可以从Markdown的语法开始学起。
- 标题不因超过四级:
# ## ### ####
- MD源文件中,同级段落之间需要空两行。
- MD源文件末尾应包含一行空行。
语言规范
- 避免使用网络语。
- 首次出现的缩写给出全名。
插入公式
-
数学公式(内联):
\('inline math')\
-
数学公式(另起新行):
$$ LaTex equation $$
使用图片
- 图片的保存: 图片保存在对应子目录下的
assets
目录中,并使用Github作为图床。如果有与之对应的原始文件 (.vsx, .drawio, .ps等),也以同样名称保存在相同目录。
引用规范
- 图片引用: 如果使用非原创图片,需要给出图片引用的出处。使用图片前应确认有无图片版权问题。
- 段落引用: 引用的内容需用双引号包含,并注明出处。
- 参考资料:参考资料应在文章末尾“参考资料”中注明。