奇迹博客所有的技术文章,都采用 Markdown 格式,如不知可查阅 Markdown 新手指南

大家一定要遵守这些规范,这样能统一文章排版,降低组员之间的交流成本。

空格

有研究显示,打字的时候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦,有七成的比例会在 34 岁的时候跟自己不爱的人结婚,而其余三成的人最后只能把遗产留給自己的猫。毕竟爱情跟书写都需要适时地留白。

与大家共勉之。

  1. 中英文之间需要增加空格;
  2. 中文与数字之间需要增加空格;
  3. 数字与单位之间需要增加空格;
  4. 链接之间要增加空格;
  5. 全形标点与其他字符之间不加空格。

标题

  1. 文章标题开头一定要有 [XXX](中括号右边文字要有空格),XXX 为关键字,加上这个文字后,Bearychat 对应的讨论组才能收到文章发布的消息,十分钟抓取一次。Bearychat 『技术探讨』组对应的关键字如下:
    • 技术探讨-Android:Android
    • 技术探讨-iOS:iOS
    • 技术探讨-服务器:Laravel、Nginx、Composer、Homestead、PHP、Sublime Text、Python、Node、Java Web
    • 技术探讨-前端:Angular 1.x、Angular 2.x、gulp、Javascript、HTML、TypeScript、CSS
  2. 内容标题,不要再把文章标题写进来;
  3. 内容标题由 ## 开始,不要出现 # 的标题;
  4. 内容标题不需要写一、二、三这种数字;
  5. 内容标题下方无需用横线;
  6. 每篇文章的索引都是根据内容标题生成的,发布文章后,要检查下索引是否有问题,如有问题,请修改内容标题。

标点符号

  1. 如写中文文章,请用中文标点符号,不要出现中英标点符号混合的情况;
  2. 简体中文使用直接引号:
    • 如:Bearychat 的『技术探讨』组

名词

  1. 专有名词使用正确的大小写:
    • 正确的:Android、Laravel、iOS、Angular;
    • 错误的:android、laravel、ios、angular。
  2. 不要使用不地道的缩写:
    • 正确的:JavaScript、HTML5;
    • 错误的:Js、h5。

代码块

  1. 代码的缩进统一为两个字符间距,请勿用四个字符或四个字符空间的 Tab 间距;
  2. 文章发布后,检查文章代码格式是否混乱。

图片

  1. 上传的图片不要有『QQ截图XXXX』这些毫无意义的名字,请认真为你的图片取个正确的名字;
  2. 图片链接 Markdown 语法的[]一定要添加上简略的描述,这样在看文章文本时可见名知意。

发表评论

电子邮件地址不会被公开。 必填项已用*标注