命令列介面

mkdocs

MkDocs - 使用 Markdown 製作專案文件。

用法

mkdocs [OPTIONS] COMMAND [ARGS]...

選項

名稱	類型	描述	預設值
-V, --version	布林值	顯示版本並結束。	False
-q, --quiet	布林值	靜音警告	False
-v, --verbose	布林值	啟用詳細輸出	False
--color / --no-color	布林值	強制啟用或停用輸出的色彩和換行。預設是自動偵測。	無
--help	布林值	顯示此訊息並結束。	False

子指令

• 建立：建立 MkDocs 文件
• 取得依賴關係：從 mkdocs.yml 中推論出所需的 PyPI 套件
• gh-deploy：將文件部署至 GitHub Pages
• 新：建立新的 MkDocs 專案
• 提供：執行內建開發伺服器

mkdocs 建立

建立 MkDocs 文件

用法

mkdocs build [OPTIONS]

選項

名稱	類型	描述	預設值
-c, --clean / --dirty	布林值	在建立之前從 site_dir 中移除舊檔案（預設）。	True
-f, --config-file	檔案名稱	提供特定的 MkDocs 組態。這可以是檔案名稱，或 '-' 從標準輸入讀取。	無
-s, --strict / --no-strict	布林值	啟用嚴格模式。這將導致 MkDocs 在出現任何警告時停止建立。	無
-t, --theme	選項（mkdocs | `readthedocs`）	在建立文件時使用的主題。	無
--use-directory-urls / --no-directory-urls	布林值	建立頁面時使用目錄網址（預設）。	無
-d, --site-dir	路徑	輸出文件建立結果的目錄。	無
-q, --quiet	布林值	靜音警告	False
-v, --verbose	布林值	啟用詳細輸出	False
--help	布林值	顯示此訊息並結束。	False

mkdocs 取得依賴關係

從 mkdocs.yml 中推論出所需的 PyPI 套件

用法

mkdocs get-deps [OPTIONS]

選項

名稱	類型	描述	預設值
-v, --verbose	布林值	啟用詳細輸出	False
-f, --config-file	檔案名稱	提供特定的 MkDocs 組態。這可以是檔案名稱，或 '-' 從標準輸入讀取。	無
-p, --projects-file	文字	宣告所有已知 MkDocs 相關專案的註冊檔檔案網址或本地端路徑。	https://raw.githubusercontent.com/mkdocs/catalog/main/projects.yaml
--help	布林值	顯示此訊息並結束。	False

mkdocs gh-deploy

將文件部署至 GitHub Pages

用法

mkdocs gh-deploy [OPTIONS]

選項

名稱	類型	描述	預設值
-c, --clean / --dirty	布林值	在建立之前從 site_dir 中移除舊檔案（預設）。	True
-m, --message	文字	承諾提交至 GitHub Pages 遠端分支時要使用的承諾訊息。承諾 {sha} 和 MkDocs {version} 可當作擴充功能使用	無
-b, --remote-branch	文字	GitHub Pages 將提交的遠端分支。這會覆寫在組態中指定的數值	無
-r, --remote-name	文字	GitHub Pages 將提交的遠端名稱。這會覆寫在組態中指定的數值	無
--force	布林值	强制將推送到儲存庫。	False
--no-history	布林值	以一個新的承諾取代整個 Git 歷史記錄。	False
--ignore-version	布林值	略過檢查舊版 MkDocs 建立的部署。	False
--shell	布林值	在呼叫 Git 時使用 shell。	False
-f, --config-file	檔案名稱	提供特定的 MkDocs 組態。這可以是檔案名稱，或 '-' 從標準輸入讀取。	無
-s, --strict / --no-strict	布林值	啟用嚴格模式。這將導致 MkDocs 在出現任何警告時停止建立。	無
-t, --theme	選項（mkdocs | `readthedocs`）	在建立文件時使用的主題。	無
--use-directory-urls / --no-directory-urls	布林值	建立頁面時使用目錄網址（預設）。	無
-d, --site-dir	路徑	輸出文件建立結果的目錄。	無
-q, --quiet	布林值	靜音警告	False
-v, --verbose	布林值	啟用詳細輸出	False
--help	布林值	顯示此訊息並結束。	False

mkdocs new

建立新的 MkDocs 專案

用法

mkdocs new [OPTIONS] PROJECT_DIRECTORY

選項

名稱	類型	描述	預設值
-q, --quiet	布林值	靜音警告	False
-v, --verbose	布林值	啟用詳細輸出	False
--help	布林值	顯示此訊息並結束。	False

mkdocs serve

執行內建的開發伺服器

用法

mkdocs serve [OPTIONS]

選項

名稱	類型	描述	預設值
-a, --dev-addr	文字	IP 位址和區域埠用於在內部提供文件（預設值：localhost:8000）	無
--no-livereload	布林值	在開發伺服器中停用即時重載。	False
--dirty	文字	僅重新編譯已變更的檔案。	False
-c, --clean	文字	在不產生任何 mkdocs serve 效果的情況下編譯網站（純粹的 mkdocs build），然後提供。	False
--watch-theme	布林值	將主題包含在要針對即時重載進行監控的檔案清單中。在不使用即時重載時，此參數將被忽略。	False
-w, --watch	路徑	要針對即時重載進行監控的資料夾或檔案。可以提供多次。	[]
-f, --config-file	檔案名稱	提供特定的 MkDocs 組態。這可以是檔案名稱，或 '-' 從標準輸入讀取。	無
-s, --strict / --no-strict	布林值	啟用嚴格模式。這將導致 MkDocs 在出現任何警告時停止建立。	無
-t, --theme	選項（mkdocs | `readthedocs`）	在建立文件時使用的主題。	無
--use-directory-urls / --no-directory-urls	布林值	建立頁面時使用目錄網址（預設）。	無
-q, --quiet	布林值	靜音警告	False
-v, --verbose	布林值	啟用詳細輸出	False
--help	布林值	顯示此訊息並結束。	False