My Blogging Style Guide

 

这是一篇只为我自己写的博客风格指南。

在多次删博客、删仓库、删帐号的经历后,我逐渐总结出了这一风格指南,希望能以此缓解我的强迫症。需要指出的是,规范风格对于缓解的帮助是极其有限的,更直接的帮助在于把这第一篇写到足够烂以后,未来就能安心地破罐破摔了。

这应该是我第四次重置我的博客了,希望这次我能坚持下去!

基本定位

  • 本博客相当于我的外部记忆装置
  • 我是唯一的作者,也是最核心的读者
  • 创作应在让自己爽的前提下,尽可能地记录我的想法
  • 别的读者爱爽不爽

主题

  • 技术类内容主要与机器人及其上游学科相关
  • 凑数类内容主要与我的爱好与我的脑洞相关

语言

  • 标签一律使用英文
  • 技术类内容以英文为主
  • 凑数类内容以中文为主

文件结构

  • 博客的文件名格式应为yyyy-mm-dd-post-title.md
    • yyyymmdd分别为年月日
    • post-title部分使用英文,字母全小写,空格等符号全部改为-
  • 博客的键值应为yyyymmdd
  • 博客的标签应为英文,并尽量重复利用
  • 博客中的专有图片、代码等文件存储在/assets/<key>中,公用文件存储在/assets/share
  • 博客的小幅度修改应在原博客上直接更新,大篇幅后续应另外发布,并用超链接的双向链表将同系列的博客串联在一起