TOC 🚀

toc	en	zh
algo	algorithm	算法
ai	artificial intelligence	人工智能
arch	architectures	体系架构
compilers	compilers	编译原理
db	databases	数据库
distributed	distributed system	分布式系统
econ	economics	经济学
	graphic	计算机图形学
langs	languages	编程语言
math	mathematica	数学
networks	networks	网络通信
netsec	security	网络安全
os	operating system	操作系统
tools	devtool	开发工具
attach	attachments	图片附件
appx	appendices	附录
	paper	论文
src	source code	代码

License

如未明确说明, 原创内容一律使用 CC-BY 4.0 许可. 您可以自由使用, 但需要保留署名.

Workflow

分为内容标签和进度标签两类, 进度标签不会出现在正文中.

tags
#LGTM	有兴趣, 最佳实践
#DEBUG	遇到的难题, 故障处理经验
#FAQ	提问, 一些好奇心
#NSFW	奇怪内容, 加入 .gitignore
#TODO	进度标签, 未来会投入精力
#NOPLAN	进度标签, 未来不会投入精力
#WIP	进度标签, 正在
#RECALL	进度标签, 需要回忆复习

文件内属性:

properties		type
source	来源统一资源定位符, 包括网址和源码路径	列表
revised	最后大幅修改日期	日期
copyright	作者与出版日期	列表
license	文内有非 CC-BY 许可证授权下的内容引用时, 单个文件许可证可能变化	文本
code	指文内内容在 /src 目录下有对应的源码	列表

Writing Guidelines

• 语言简洁, 严谨, 准确. 体现逻辑性, 减少冗余.

• 强调句使用粗体, 新名词使用斜体.

• 全部使用英文标点, 半角标点前或后添加一个半角空格.

• 中文 (全角) 和任意半角符号间应隔一个半角空格, 括号内侧除外.

• 标题级别从二级开始, 最低四级标题.

• 标题中可以有空格, 编号和题目间应有空格, 次级编号用 . 分隔.

• 文章篇幅不宜过长, 5个以内三级标题为宜.

• 所有流程类内容 (非事实, 非概念), 均用 Q&A 形式记录.

• 自绘图片保存在 ./attach 中, 其余放置于阿里云 OSS.

Markdown

• Markdown 开启严格断行.
• Markdown 链接使用 []() 形式, 关闭 wikilink.
• 允许的 Obsidian Markdown 语法: Properties, ...

Naming

• 普通目录及文件: 用 - 作为连字符, 减少空格, 全小写.
• 源码目录及文件: 遵循语言规范, 通常使用 _ 作为连字符.
• 无空格

Appearance

• 文本字体: "文泉驿等宽微米黑", 保证英文和中文字宽对齐.
• 代码字体: "FiraMono Nerd Font Mono".
• Obsidian Github Theme.

Coding

详见 自用代码规范

Reference

• 大篇幅参考时, 在开头文章元信息处列明来源.
• 小篇幅参考时, 在文内用脚注列明来源. 脚注内容应统一放在文末, 不要穿插在文间.
• 图片应在 [] 括号中列明来源, 尽量自行绘制, 并压缩空间.
• 仓库整体使用 CC-BY 许可证, 部分摘录文章或原创文章使用不同版权许可的, 在文章开头标明.
• 文内引用学术论文时, 简写为 @yu2021, 其中 yu 为作者姓, 2021 为发表年份. 详细信息应记录在 appx/references.bib 中, 不强制要求脚注.
• 如果文内引用需要其他元信息, 统一写在括号里: [ITU-T x.800, 2002, p22].

Math

• 数学中独立的定理, 引理, 定义, 例子皆使用标题格式, 便于链接和折叠. 证明, 命题使用正文加粗格式.
• 数学标题应使用数字层次标号, 如 1.3.1.
• 数学定理和定义内容使用粗体, 用 <br> 增长段间距.
• 数学证明中, 每行 (段内换行) 要不是完整的因果关系 "因为..所以..", 要不是上一行的直接推论 "于是.." "从而.." "那么..".
• 数学证明中, 用 证明: 和 $\blacksquare$ 标识开始与结束.
• 数学公式符号 $$ 和左右文字间隔一个半角空格, 避免渲染问题.