书籍写作规範

优质

小牛编辑

130浏览

2023-12-01

专有名词

技术类专有名词依循官方常见用法。

以中文全形标点符号为主。

遇英文段落（整句）採用一般（半形）标点符号。

中文与英文单字之间以一个空白字元隔开，标点符号与英文单字之间不需要空隔。

这是为了让排版显示的自动断词断句可以正确运作，以及增加中英文混杂段落的阅读舒适。

中文同一段落为了方便编辑，可以将句子断行；但行尾必须加上半形「」倒斜线符号。因为在 HTML、EPUB 或 MOBI 格式中，换行字元会被当做空白字元处理，导致增加过多影响版面美观的空隔。

只有一行、不需要 Highlight，或是一般的 command line 操作指令说明，使用 reStructuredText 标準 Code 写法。

This is line One
This is line Two

片段程式码（snippets），使用 inline code block，并指定 language type。

程式码与 .. code-block 之间一定要隔一个空行，且一定要有程式码（否则文件无法编译）。

if (something) {
    alert('test');
}