SwiftGG 排版指南.md

SwiftGG 翻译组排版指南

目录

• 空格
  • 中英文之间需要增加空格
  • 中文与数字之间需要增加空格
  • 数字与单位之间需要增加空格
  • 行内代码和文字之间需要增加空格
  • 行内链接和文字之间需要增加空格
  • Emoji
  • 中文标点与其他字符之间不加空格
• 标点符号
  • 不重复使用标点符号
• 全角和半角
  • 使用全角中文标点
  • 数字使用半角字符
  • 遇到完整的英文整句、特殊名词，使用半角标点
• 名词
  • 专有名词使用正确的大小写
  • 不要使用不地道的缩写
• 引用
  • 使用 [^1] 进行脚注标记
• 文章内部跳转
  • 写法

特别注意❗️

Markdown 的【加粗】和【斜体】，内容部分不能有空格，否则样式解析会出错。

具体来说： ✅

这是正确的加粗和斜体写法

英文加粗 code 和斜体 code 的写法，空格放在样式外面

❌

这是错误的**加粗 **和*斜体 *写法

可以明显看到，错误的部分解析出来的样式完全不对，请大家注意。

空格

中英文之间需要增加空格

✅

我们是 SwiftGG 翻译组

❌

我们是SwiftGG翻译组

我们是SwiftGG 翻译组

我们是 SwiftGG翻译组

❗️ 注意：无论英文是否是一个链接（[]()）还是某种变量（使用 ` ` 引起来的内容），遇到中文都应该前后增加空格。

✅

+ [这是一个链接](github.com/Cee)。也可以通过访问 [Swift Evolution](https://github.com/apple/swift-evolution) 获得更多详细的解释。

❌

- [这是一个链接](github.com/Cee)。也可以通过访问[Swift Evolution](https://github.com/apple/swift-evolution)获得更多详细的解释。

中文与数字之间需要增加空格

✅

这篇文章有 3 个小节

❌

这篇文章有3个小节

这篇文章有3 个小节

这篇文章有 3个小节

数字与单位之间需要增加空格

✅

文件大小是 1 MB

❌

文件大小是 1MB

行内代码和文字之间需要增加空格

这条实际上和“中英文之间需要增加空格”一致，因为行内代码肯定是英文。

同理，如果行内代码两侧是标点符号，不需要增加空格。

✅

创建一个名为 SwiftGG 的类

❌

创建一个名为SwiftGG的类

行内链接和文字之间需要增加空格

这样做的原因是网站使用的 Hexo 在渲染链接时没有添加两侧间距，会导致链接直接和文字连在一起，比较别扭，所以无论链接内容是中文还是英文，和正文之间都需要隔开。

如果链接两侧是标点符号，不需要增加空格。

✅

更多信息请访问 我们的网站

❌

更多信息请访问我们的网站

Emoji

Emoji 和中文字符（包括中文标点）之间不加空格

✅

真棒🎉。

❌

真棒 🎉 。

Emoji 和英文之间遵循原文格式

中文标点与其他字符之间不加空格

✅

我的 GitHub 帐号是 @Cee，其他的联系方式可以私信。

❌

我的 GitHub 帐号是 @Cee ，其他的联系方式可以私信。

标点符号

不重复使用标点符号

✅

你刚才说的话是认真的吗？

❌

你刚才说的话是认真的吗？？？

全角和半角

使用全角中文标点

使用全角中文标点符号 （，、。、、、「」、（）），这里注意，省略号也要换成中文省略号，输入方式是 shift + 6。

✅

哇！你注意到这篇文章的要点了么？

❌

哇!你注意到这篇文章的要点了么?

✅

应用程序上下文（Application Context）通常用于下列情况。

❌

应用程序上下文(Application Context)通常用于下列情况。

数字使用半角字符

✅

代码共有 100 行

❌

代码共有１００行

遇到完整的英文整句、特殊名词，使用半角标点

✅

推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》，非常的有趣。

❌

推荐你阅读《Hackers＆Painters：Big Ideas from the Computer Age》，非常的有趣。

名词

专有名词使用正确的大小写

✅

使用 GitHub 登录

我们的客户有 GitHub、Google、Facebook 等

❌

使用 github 登录

使用 Github 登录

使用 gitHub 登录

使用 GITHUB 登录

我们的客户有 github、google、facebook 等

我们的客户有 GITHUB、GOOGLE、FACEBOOK 等

我们的客户有 Github、Google、FaceBook 等

不要使用不地道的缩写

✅

我们需要一位熟悉 JavaScript 和 HTML5 的前端开发者。

❌

我们需要一位熟悉 Js 和 h5 的 FED。

引用

使用 [^1] 进行脚注标记

✅

原文出处[^1]

---

^1: http://zh.wikipedia.org/wiki/%E5%85%A8%E5%BD%A2%E5%92%8C%E5%8D%8A%E5%BD%A2

文章内部跳转

写法

这里是正文，我们要跳转到 [某个目标](#target-name)。

<a name="target-name"></a>
跳转目标

比如，我们要跳转到 本文开头，点击链接就可以跳到本文开头。如果你查看这篇文章的 源代码，可以看到全文最开头有一个 <a name="beginning"></a>，上一句的链接写法是 [本文开头](#beginning)。