關於本站¶
本站是使用 Sphinx (2.4.4) 建置的，這是一個開源工具，用於建立官方 Python 文件和許多其他網站。這是一個非常成熟且穩定的工具，被選中的原因之一是它支援定義 API 項目並從程式碼連結到它們。
本站使用一個自訂主題，該主題基於 Read the docs 主題。
搜尋本站¶
搜尋會返回包含所有指定關鍵字的項目。
提示
請務必從搜尋「互動」或「編譯」等單字開始。通常這樣就足以找到相關的文件。如果找不到，您可以加入其他詞彙來完善搜尋。
注意
包含「-」和「+」等字元的搜尋將無法運作。不支援邏輯運算子。
回報錯誤¶
貢獻於本站¶
歡迎對本站（以及 Emscripten 的任何部分）做出 貢獻！
建置本站¶
本站的原始碼儲存在 GitHub 上。編輯和新增內容應以與工具其他變更相同的方式提交到此分支。
本站發佈到 emscripten-core/emscripten-site gh-pages 分支 (GitHub 頁面)。
注意
請記住在公開版本中更新 建置版本。
安裝 Sphinx¶
本站需要安裝特定版本的 Sphinx。請執行以下命令以確保您已安裝正確的版本
pip install -r requirements-dev.txt
網站建置¶
可以透過導覽至 /emscripten/site 目錄並使用以下命令，在 Ubuntu 和 Windows 上從原始碼建置網站
make clean
make html
SDK 建置¶
SDK 建置實際上與 網站建置 相同。主要區別在於，在 SDK 建置中，首頁 會清楚地通知它是一個 SDK 建置。
透過啟用 sdkbuild 標籤來啟用 SDK 建置。這是透過 SPHINXOPTS 環境變數完成的
# Set the sdkbuild tag.
set SPHINXOPTS=-t sdkbuild
make html
# Unset SPHINXOPTS
set SPHINXOPTS=
建置版本¶
文件的版本應與目前建置的 Emscripten 版本相符。對於一般網站建置，這將是 Emscripten 版本 中定義的最新標籤發行版本。對於 SDK 建置，它將是 SDK 的 Emscripten 版本。
版本和發行資訊會在文件中的幾個地方使用，例如 作者。
版本資訊定義於 conf.py 中 — 請參閱變數 version 和 release。可以透過在 SPHINXOPTS 環境變數中設定新值來覆寫這些變數。例如，若要在 Windows 的命令列上更新 release 變數
# Set SPHINXOPTS
set SPHINXOPTS=-D release=6.40
make html
# Unset SPHINXOPTS
set SPHINXOPTS=
撰寫和更新文章¶
網站內容是使用 reStructured text 撰寫的。我們建議您閱讀以下文章以了解語法
樣式指南¶
本節有一些非常簡短的建議，以幫助作者使用常見的樣式。
提示
就貢獻而言，我們重視您的程式碼撰寫和內容撰寫，遠勝於完美的散文！盡力而為，然後 請求編輯審查。
拼寫：盡可能使用美式英語拼寫。
避免使用慣用語：這些對於非母語人士來說可能特別令人困惑（例如，「putting your foot in your mouth」實際上是指「說了一些令人尷尬的事情」）。
強調
粗體：用於檔案名稱和 UI/選單指示（例如：「按一下確定以執行某些操作」）。
斜體：用於工具名稱 - 例如 Clang、emcc、Closure Compiler。
monotype：用於內嵌程式碼（您無法連結到 API 參考時）和示範工具命令列選項。注意
除了上述規則之外，應謹慎使用強調。
清單：在適當情況下，請在清單的引導詞上使用冒號。每個項目都應大寫第一個字母並使用句點。
如何連結到文件或標題¶
若要連結到頁面，請先在頁面標題之前定義一個全域唯一參考（例如 _my-page-reference），然後使用 ref 角色連結到它，如下所示
.. _my-page-reference:
My Page Title
=============
This is the text of the section.
To link to page use either of the options below:
ref:`my-reference-label` - the link text is the heading name after the reference
ref:`some text <my-reference-label>` - the link text is "some text"
這比使用 :doc: 角色連結到文件更好，因為如果文章被移動，連結不會被中斷。
建議使用這種方法來連結到網站中的任意標題。
注意
還有許多其他角色可用於連結，包括用於連結程式碼項目的 Sphinx 網域 和用於連結到詞彙表項目的 term。
建議的章節/標題標記¶
reStructured text 使用 標題文字之後（以及選擇性地之前）的單獨標點字元行來定義章節標題。字元行必須至少與標題一樣長。例如
A heading
=========
不同的標點字元用於指定巢狀章節。雖然系統並未強制規定每個巢狀層級應使用哪個標點字元，但保持一致性非常重要。建議的標題層級為
=======================================
Page title (top and bottom bars of "=")
=======================================
Level 1 heading (single bar of "=" below)
=========================================
Level 2 heading (single bar of "-" below)
-----------------------------------------
Level 3 heading (single bar of "+" below)
+++++++++++++++++++++++++++++++++++++++++
Level 4 heading (single bar of "~" below)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
使用 markdown¶
可以使用 Markdown 語法在 wiki 上撰寫和討論新文章，然後再將其納入文件集中。將這些轉換為 reStructured text 的最簡單方法是使用 Pandoc 等工具。
注意
get_wiki.py 工具 (/site/source/get_wiki.py) 可用來自動取得 wiki 的快照。它會複製 wiki 並對每個檔案呼叫 pandoc。輸出會被複製到 wiki_static 資料夾。此工具還會新增標題、註明檔案為「wiki 快照」的說明，並將標記為「行內程式碼」的連結修正為 API 參考中的對應連結。
Read the docs 主題¶
此網站使用 Read the docs 主題 的修改版本（可在 /emscripten/site/source/_themes/emscripten_sphinx_rtd_theme 的原始碼中找到）。
以下列出對原始主題的主要變更。
Footer.html
版權資訊已變更為連結到 Emscripten 作者 (某些程式碼因翻譯標記而損壞)
新增頁尾選單列
Layout.html
新增包含項目的頁首選單列
Breadcrumb.html
將第一個連結的文字從「docs」變更為「Home」
將「檢視頁面原始碼」程式碼移至底部頁尾
theme.css
變更為支援側邊欄目錄中 4 個層級的深度。
置中主題。使用絕對定位使側邊欄延伸至頁面底部。