Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.2 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.2 KB

大家來寫書!

檔案說明

  • _toc.md Table of Content,章節列表
  • author.md 作者簡介
  • chapter-01.md 章節數使用兩位數數字,不足兩位數補零。
  • chapter-03-wip.md 檔名後面加上 wip 表示 Work In Progress,正在進行中。
  • 附圖或其它提供下載之檔案,請放至相對應章節目錄裡,例如 assets/chapter-01

使用說明

  • 使用 Markdown 語法

    • 每個章節僅有開頭使用 H1
    • 其它段落使用 H2 或 H3,盡量不使用 H4 ~ H6
    • 程式碼或關鍵字適時的使用 backtick,例如:
    function hello() {
      console.log("hey");
    }
  • 注意程式碼縮排,為了避免電子書或紙本書印刷時超過寬度,請使用 2 個空白字元進行縮換

  • 引用圖片或其它資源請注意授權

  • 標點符號

    • 文字請使用全型標點符號(包括冒號、頓號、小括號等)
  • 秉持 Unix 系統的哲學:「Do One Thing and Do It Well」,一次只專注寫一個章節,章節完成後就發一次 PR 並在 GitHub 上請技術校閱人員進行校閱

  • Happy Hacking!

  • 有任何建議或想法,或是想要報隊寫書,都歡迎來信至 eddie@5xcampus.com