Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

编写规范 #89

Open
vincent4j opened this issue Jun 30, 2014 · 0 comments
Open

编写规范 #89

vincent4j opened this issue Jun 30, 2014 · 0 comments

Comments

@vincent4j
Copy link
Contributor

字体

  • 大小
    • 标题大小:# 标题标签对应的字体大小
    • 默认大小:包括正文、插图说明等;简单点,除了 h 标签其他都是默认

提示:如何知道原文的字体大小?在浏览器里查看源码,是不是位于 h 标签之下。

  • 颜色:除了加粗,其他全部默认

插图 & 视频

  • 每行只显示一张图片或一个视频(因为一行并排显示多张或多个,markdown 处理麻烦)
  • 直接下载原图(大小取 mdpi 尺寸)
  • 无需对原图进行二次加工(即使有英文)
  • 对齐:居左对齐(就是 markdown 默认)
  • 插图或视频说明文字:如果有,统一写在图片或视频的下一行(换行,但不用空一行);如果没有,不用自己造说明

问:原图太大,如何处理?
答:#57

问:如何添加视频?
答:#90

章节中的目录:不保留

在每章的头部,大概应该是第一段之后都会有个本章目录 Contents,我们舍弃这一部分,也就是在翻译稿里不要这部分。出发点,单章的内容不会太多,再就是写这部分还要加 锚点 比较费时。

章节中每个二级标题之间的分割线:不保留

原文中每个章节内部的二级标题之后都会人为的加入一条分割线(对应 markdown 中的连续三个等于号),而我们使用的 markdown 语法的 h2,默认就会在标题下一行加入分割线,导致重复;所以翻译稿里不保留 h2 标题上方的分割线。

Jekyll 头部信息

因为工程最终运行在 Jekyll 之下,所以必须按照其要求添加头部信息。
操作如下:#81

资源文件下载添加

  • 链接:在原始链接的基础上用域名「materialdesign.qiniudn.com」替换掉「material-design.storage.googleapis.com」;
    例如:http://materialdesign.qiniudn.com/downloads/color_swatches.zip
  • 文字描述:名称 + 空格 + 减号 + 空格 + 大小 + 英文括号 + 扩展名 + 英文反括号;
    形如:色样 - 0.13 MB(.zip),给「名称」添加链接,不是给整体。
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant