文件工具示範¶

主題檢查清單¶

此示範旨在測試 BeeWare MkDocs Material 主題覆寫的各項功能。請仔細閱讀並確認本頁及後續頁面所列的所有項目均存在且運作如說明所述。

頁面顯示中灰色標題列。此主題範本已套用。

左上角的頁首圖示已完成渲染。這確認了該範本可引用外部資源。

左側邊欄的標誌圖示已完成渲染。標誌寬度應與邊欄相同，高度亦需與邊欄等高。網站標題應以略大於邊欄其他文字的字型顯示於標誌下方，版本號則以較小字型置於標題下方。

這確認側邊欄將在目標網站上正確顯示。

標題以斜體呈現。這確認了 BeeWare 自訂 CSS 主題已成功套用。

內嵌程式碼會以與周圍字體相同的顏色呈現。這確認了主題並未造成任何不必要的變更。

此處為包含 inline code 的文字，此處亦包含 inline code。

程式碼採用與背景色對比的顏色。複製按鈕應僅複製指令內容，不包含提示符。

這確認了主題並未造成任何不必要的變更，同時也驗證了複製按鈕是否如預期般運作。

macOSLinuxWindows

$ git clone https://github.com/beeware/beeware-theme.git

$ git clone https://github.com/beeware/beeware-theme.git

C:\...>git clone https://github.com/beeware/beeware-theme.git

以下程式碼區塊中的複製按鈕應將 from pathlib import Path 複製到剪貼簿。

from pathlib import Path

以下程式碼區塊中的複製按鈕應將 ls beeware-docs-tools 複製至剪貼簿。請勿包含命令提示字元及輸出內容。

(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt  tox.ini
docs pyproject.toml    requirements.docs.txt
LICENSE README.md    src

側邊欄連結存在，且指向 beeware-docs-tools 儲存庫。這確認了側邊欄內容已載入，且 project-name 已在 MkDocs 設定檔中設定，同時版本號碼已計算並加入。

此連結至 BeeWare 主要網站的文字，無論在淺色模式或深色模式下，都應呈現藍色。

左右側邊欄的連結在兩種模式下也應呈現藍色。

當向下滾動頁面時，右側邊欄中的活動標題連結在深色模式下應顯示為淺藍色，而在淺色模式下則應顯示為深藍色。

本文件的英文版本應顯示下方「提供翻譯版本」的提示。法文翻譯版本應顯示「此為機器翻譯！」的提示。德文翻譯版本應顯示「此為人工翻譯！」的提示。

這是機器翻譯！

本教學指南版本由機器翻譯生成。我們明白這並非理想方案，但認為劣質翻譯仍勝於毫無翻譯。

在瀏覽器網址列的末尾添加 nopage 以驗證 404 頁面是否存在，並確認其包含文字「Brutus 無法找到您要的內容」。由於 MkDocs 的問題，當前 404 頁面並非總是能正確顯示圖片。

MkDocs 因無法識別內部連結而導致建置失敗，因此您需要手動修改瀏覽器中的網址以驗證此檢查機制。

以下連結應可引導您前往 BeeWare Docs 工具示範區段一。此連結旨在驗證跨頁面連結功能。