跳轉到

共享內容測試平台

本節旨在驗證由本儲存庫提供的共享內容,以供 BeeWare 文件其他部分使用。「共享內容」指的是多個其他儲存庫共用的文件或文件段落。這些內容儲存於此處,以便在各儲存庫中進行整合。這意味著當需要更新時,僅需修改單一來源,變更便會自動同步至所有使用該共享內容的儲存庫。

若您正在更新現有內容,則無需執行以下步驟。您只需建立測試網站,即可查看更新內容的呈現效果。

若您正在 shared-content 目錄中建立新的共享文件檔案,且該檔案不應包含在 how-to 目錄中,請完成以下步驟:

  1. content_test_bed 目錄中建立一個與新內容檔案同名的檔案,並在檔案名稱末尾附加「_include」。
    • 對於 style_guide.md, 您需要添加 style_guide_include.md.
  2. 使用片段語法時,請將檔案名稱加入 filename_include.md 中。片段語法中用於包含內容的結構為 -8<- "filename.md"
    • 對於 style_guide.md, 您需要在 -8<- "style_guide.md" 中添加 style_guide_include.md
  3. 請更新 Shared content test bed 區段中的 /docs/SUMMARY.md 部分,加入新的 _include 檔案與路徑,並保持與該區段中其他項目相同的縮排層級。
    • 對於 style_guide_include.md,您需要添加 - [Style guide](content_test_bed/style_guide_include.md)

完成這些步驟後,您即可建立測試網站並檢視新文件的呈現效果。