撰稿指南
下列各節包含您需要知道的所有內容，關於編輯和格式化此網站中的內容。在開始編輯或新增前，請務必進行一些研究。有時最困難的部分是找出內容應放置的位置，並確定它是否已存在。
流程
- 如果一篇文章連結到相關議題，請檢查相關議題。
- 按一下
編輯並擴充結構。 - 公關變更。
YAML 前置資料
每篇文章在最上方都有一個小節，使用 YAML 前置資料 撰寫
---
title: My Article
group: My Sub-Section
sort: 3
contributors:
- [github username]
related:
- title: Title of Related Article
url: [url of related article]
---讓我們來分析這些資料
標題：文章的名稱。群組：小節的名稱排序：文章在其小節（或）小節（如果存在）中的順序。貢獻者：已為這篇文章做出貢獻的 GitHub 使用者名稱清單。相關：任何相關閱讀或有用的範例。
請注意，相關會在頁面底部產生一個進一步閱讀小節，而貢獻者會在下方產生一個貢獻者小節。如果您編輯一篇文章並希望獲得認可，請不要猶豫，將您的 GitHub 使用者名稱新增到貢獻者清單中。
文章結構
- 簡要介紹 - 一或兩段，讓您了解基本概念和原因。
- 概述剩餘內容 – 內容的呈現方式。
- 主要內容 - 告訴您承諾要告訴的內容。
- 結論 - 告訴您所說的內容並回顧重點。
排版
- Webpack 可以在句子的開頭寫成大寫 W。(來源)
- 載入器用反引號括起來，並使用 連字符大小寫：
css-loader、ts-loader、… - 外掛用反引號括起來，並使用 駝峰式大小寫：
BannerPlugin、NpmInstallWebpackPlugin、… - 使用「webpack 2」來指特定 webpack 版本 (
"webpack v2") - 使用 ES5；ES2015、ES2016、… 來指 ECMAScript 標準 (
ES6、ES7)
格式化
程式碼
語法：```javascript … ```
function foo() {
return 'bar';
}
foo();引號
在程式碼片段和專案檔案中使用單引號 (.jsx、.scss 等)
- import webpack from "webpack";
+ import webpack from 'webpack';以及在內嵌反引號中
正確
將值設定為 'index.md'...
錯誤
將值設定為 "index.md"...
清單
- Boo
- Foo
- Zoo
清單應按字母順序排列。
表格
| 參數 | 說明 | 輸入類型 | 預設值 |
|---|---|---|---|
| --debug | 切換載入器至偵錯模式 | 布林值 | false |
| --devtool | 定義已套件化資源的原始碼對應類型 | 字串 | - |
| --progress | 以百分比列印編譯進度 | 布林值 | false |
表格也應按字母順序排列。
組態屬性
應將組態屬性按字母順序排列
devServer.compressdevServer.hotdevServer.static
引號
區塊引用
語法：>
這是一個區塊引用。
提示
語法：T>
語法：W>
語法：?>
假設和簡潔性
撰寫文件時不要做任何假設。
- You might already know how to optimize bundle for production...
+ As we've learned in [production guide](/guides/production/)...請勿假設事情很簡單。避免使用「只要」、「簡單地」等字詞。
- Simply run command...
+ Run the `command-name` command...組態預設值和類型
為所有文件選項提供類型和預設值，以確保文件易於存取且撰寫良好。我們會在命名已記載的選項後新增類型和預設值
configuration.example.option
字串 = 'none'
其中 = 'none' 表示給定選項的預設值為 'none'。
字串 = 'none': 'none' | 'development' | 'production'
其中 : 'none' | 'development' | 'production' 列舉可能的類型值，在本例中，可接受三個字串：'none'、'development' 和 'production'。
在類型之間使用空格來列出給定選項的所有可用類型
字串 = 'none': 'none' | 'development' | 'production' 布林值
要標記陣列，請使用方括號
字串 [字串]
如果在 陣列 中允許多種類型，請使用逗號
字串 [字串、正規表示法、函式(arg) => 字串]
要標記函式，請在有可用引數時也列出引數
函式 (編譯、模組、路徑) => 布林值
其中 (編譯、模組、路徑) 列出提供的函式將接收的引數，而 => 布林值 表示函式的傳回值必須是 布林值。
要將外掛標記為可用的選項值類型，請使用 外掛 的駝峰標題
TerserPlugin [TerserPlugin]
這表示選項需要一個或幾個 TerserPlugin 執行個體。
要標記數字，請使用 數字
數字 = 15: 5、15、30
要標記物件，請使用 物件
物件 = { prop1 字串 = 'none': 'none' | 'development' | 'production'、prop2 布林值 = false、prop3 函式 (模組) => 字串 }
當物件的鍵可以有多種類型時，請使用 | 來列出它們。以下是一個範例，其中 prop1 可以同時是字串和字串陣列
物件 = { prop1 字串 = 'none': 'none' | 'development' | 'production' | [字串]}
這讓我們可以顯示預設值、列舉和其他資訊。
如果物件的鍵值是動態的、使用者自訂的，請使用 <key> 來描述它
object = { <key> string }
選項簡表及其類型
有時，我們想要描述物件和函式的特定屬性。在適用的情況下，請直接將類型新增至列出屬性的清單中
madeUp(boolean = true)：簡短說明shortText(string = 'i am text')：另一個簡短說明
可以在 EvalSourceMapDevToolPlugin 頁面的選項區段 中找到範例。
新增連結
請使用相對 URL (例如 /concepts/mode/) 來連結我們自己的內容，而不是使用絕對 URL (例如 https://webpack.dev.org.tw/concepts/mode/)。
2 貢獻者
