Binary Life

诗人 方法论者 喝汤族 微微爸

Markdown Style

  • 本文仅用于有洁癖者(本人)统一 markdown 风格, 以及 check style

行文

标点

  • 除非必要, 所有标点都使用英文标点

强调

  • 说明性的词和短语用双引号(“”)强调
  • 提示性的词和短语用双星号(**)强调
  • 结论性的短语和句子用三星号(***)强调

删除

  • ~~删除的文字~~ -> 删除的文字

空格

  • 第一级列表标记(比如*)前不需要空格
  • 英文单词的前后都需要空格
    • 行首不需要前面的空格, 句尾不需要后面的空格
    • 如果英文单词在括号里, 则前后的空格写在括号外, 比如 “ (abc) ” 或 “ (abc 很不错)”
  • 左引号前和右引号后都需要空格
    • 行首不需要前面的空格, 句尾不需要后面的空格
  • 强调标记的前后都需要空格
    • 行首不需要前面的空格, 句尾不需要后面的空格

链接

  • 行文中需要文字的, 使用引用方式
  • 直接贴链接不影响行文的, 可以直接贴连接
    • 比如 少量 不是很长 且 在行尾 的链接
    • 比如 少量 不是很长 的链接列表
  • 其它情况均需要使用引用方式, 引用需要集中写在文章或段落末尾
[Display Name][name]
...

 [name]: http://external.link "Link Description"
 [name]: /blog/yyyy/MM/dd/internal-link/ "Link Description"

更新

  • 在文档末尾添加
****
Update@yyyy.MM.dd: 更新的内容

大小写

  • TODO

用词

  • 举例时用 “比如”, 不用 “如”; “比如” 后面不加冒号, 除非后面跟着列表
  • 并列时用 “和”, 不用 “及”; 除非需要使用 “以及”
  • “其他” 修饰人, “其它” 修饰非人

代码

单行模式

  • 一行可执行代码使用变音符号(`)单行模式
  • 一行文本内容使用变音符号单行模式或 pre-code 多行模式
  • 特殊记号使用变音符号单行模式
    • 比如文件路径 C:\Windows
    • 比如代码元素 ++ --
  • 变音符号单行模式的空格规则同引号

可执行代码和支持代码高亮的文本

不支持代码高亮的文本内容

  • 使用 pre-code 多行模式
  • 打开该文本文件的命令可以写在一起, 命令和文本之间空一行

Comments