返回介绍

書籍寫作規範

发布于 2022-02-15 21:25:22 字数 876 浏览 772 评论 0 收藏 0

專有名詞

技術類專有名詞依循官方常見用法。

  • Node.js
  • npm
  • JavaScript

標點符號

以中文全形標點符號為主。

  • ,、。!「」()

遇英文段落(整句)採用一般(半形)標點符號。

中文與英文單字之間以一個空白字元隔開,標點符號與英文單字之間不需要空隔。

這是為了讓排版顯示的自動斷詞斷句可以正確運作,以及增加中英文混雜段落的閱讀舒適。

  • Node.js 是一種適合用於 Server-side 的開發框架(Framework),相當 Nice!

特殊排版說明

中文同一段落為了方便編輯,可以將句子斷行;但行尾必須加上半形「」倒斜線符號。因為在 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');
}
.. literalinclude:: src/hello.js
   :language: javascript

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文