1
0
mirror of https://github.com/LearnOpenGL-CN/LearnOpenGL-CN.git synced 2025-08-22 20:25:28 +08:00

Add styleguide

This commit is contained in:
Meow J
2015-07-27 19:41:03 +08:00
parent 26d7793ef6
commit ef5a9a5da3
2 changed files with 47 additions and 1 deletions

46
styleguide.md Normal file
View File

@@ -0,0 +1,46 @@
# 校对指南(Styleguide)
- **对照原文**
- 使用中文的标点符号: 逗号,双引号
- 使用英文的标点符号: 括号(去讨论下剩下的,像句号之类的)
- 文本中常量/代码用``加注为代码
- 代码块不使用Tab标注改为用```式标注
- 每一节标题使用`#` (h1)标题(到后面会有几节有很多小节的,太小的标题不明显)
- 根据原文标题大小逐渐递增标题
- 注意"#"后标题前要空格
- 专有名词在对照表里找翻译,需要用括号标注原文
- 原文单词按照标题大写规则大写首字母
- 尽量大部分都翻译掉
- 在Markdown文件中如需插入图片或者代码请与正文空一行
例:
```markdown
[text]
[img]
[text]
```
- 翻译注释
- 原文中的斜体一律用加粗表示(中文并不存在斜体)
- 每一节前面加上
```
原文 | [英文标题](原文地址)
---|---
作者 | 作者
翻译 | 翻译
校对 | 校对
```
- 公式用[http://latex2png.com/](http://latex2png.com/)转换文本中的公式Resolution为150单独的公式为200
- 视频用Video标签添加
```html
<video src="url" controls="controls">
</video>
```
**如果有不全的继续加**