GitHub 有一項稱為 Codespaces 的功能,可用來參與 PowerShell 檔,而不需要在本機安裝或設定任何軟體。 當您使用 Codespace 時,您會取得小組用來撰寫和編輯的相同撰寫工具。
您可以在瀏覽器中使用 Codespace,在透過因特網裝載的 VS Code 中做出貢獻。 如果您已在本機安裝 VS Code,您也可以連線到該處的程式代碼空間。
可用工具
當您使用程式代碼空間參與 PowerShell 檔時,您的編輯器已有這些工具可供您使用:
- Markdownlint 用於檢查您的 Markdown 語法。
- cSpell 用於檢查您的拼字。
- Vale 用來檢查你的散文。
- 學習撰寫套件,用於插入平臺特定語法、預覽您的貢獻等等。
- Reflow Markdown 延伸模組,可視需要重新調整您 Markdown 的格式,讓閱讀和編輯變得更容易。
- 數據表格式器延伸模組,可讓您的數據表更容易閱讀,而不需要手動對齊數據行。
- 用於轉換標題和文章大小寫的 變更大小寫 擴充功能。
- 用來檢閱歷程記錄檔案變更的 GitLens 延伸模組。
- 用於互動撰寫 PowerShell 範例的 PowerShell 延伸模組。
- 適用於 Visual Studio Code 的 Gremlins 追蹤器,用於在 Markdown 中尋找有問題的字元。
費用
GitHub Codespaces 每月最多可使用 120 個核心時數。 每月使用量會跨所有存放庫計算,而不僅限於文件。
如需定價的詳細資訊,請參閱 關於 GitHub Codespaces 的計費。
小提示
如果您熟悉使用容器和 Docker,可以使用針對 PowerShell 檔存放庫定義的 devcontainer 來取得相同的體驗。 使用 devcontainers 沒有任何相關成本。 如需詳細資訊,請參閱 開發容器教學課程。
建立 GitHub Codespace
若要建立 GitHub Codespace 以參與 PowerShell 文件,請遵循下列步驟:
- 在瀏覽器中開啟 https://github.com/codespaces。
- 選取頁面右上方的 [新增代碼空間] 按鈕。
- 在 [建立新的程式碼空間] 頁面中,選取 [選取存放庫] 按鈕,然後輸入您要參與的存放庫名稱,例如
MicrosoftDocs/PowerShell-Docs
。 - 將所有其他設定保留為預設值。
- 選取 [建立代碼空間] 按鈕。
遵循這些步驟之後,GitHub 會為該存放庫建立新的程式碼空間,併為您設定它。 當 Codespace 就緒時,頁面會重新整理並顯示 Codespace 的 Web 編輯器 UI。 UI 是以 VS Code 為基礎,運作方式相同。
開啟 GitHub Codespace
若要在瀏覽器中開啟 GitHub Codespace,請遵循下列步驟:
- 在瀏覽器中開啟 https://github.com/codespaces。
- 頁面會列出您的 Codespaces。 尋找您想要貢獻的存放庫所建立的代碼空間,然後選擇它。
選取程式代碼空間之後,GitHub 會在相同的視窗中開啟它。 從這裡開始,您已準備好參與。
若要在 VS Code 中開啟 GitHub Codespace,請遵循 在 Visual Studio Code 中使用 GitHub Codespaces 中的步驟。
在 GitHub Codespace 中撰寫
在瀏覽器中開啟 GitHub Codespace 或 VS Code 之後,貢獻文件會遵循相同的流程。
本文的其餘部分說明撰寫或編輯您的貢獻時,您可以在 GitHub Codespace 中執行的工作選擇。
擷取參考連結
當您想要將內嵌連結,例如 [some text](destination.md)
,轉換成類似 [some text][01]
的參考連結時,請選取編輯器中的連結目的地。 然後您可以:
- 使用滑鼠右鍵點擊連結,然後在選單中選取「重構...」。
- 按 Ctrl+Shift+R。
任一操作會引發重構內容功能表。 若要在連結中將 (destination.md)
替換為 [def]
,請在功能表中選取 [擷取至連結定義]。 您可以在 中輸入名稱來重新命名定義。
針對 PowerShell 檔,我們使用兩位數的數值參考連結定義,例如 [01]
或 [31]
。 僅在介紹文章和概念文件中使用參考連結定義。
請勿在 Cmdlet 參考檔中使用參考連結定義。
修正散文風格違規
當您在程式代碼空間中檢閱文章時,Vale 會在您第一次開啟該文章以及每次儲存它時自動檢查。 如果 Vale 發現任何樣式問題,它會在文件中用彩色波浪線標示出來。
將滑鼠停留在違規上方,以查看其詳細資訊。
若要開啟說明規則的網頁,請在暫留資訊中選取規則的名稱。 若要開啟規則並檢閱其實作,請選取規則的檔名(結尾為 .yml
)。
如果規則支援快速修正,您可以在違規的懸停資訊中選取「快速修正...」,並從右鍵選單中選取建議的修正來套用。 您也可以按 Ctrl+。當您的 游標位於反白顯示的問題時,如果規則支援,則套用快速修正。
如果規則不支援快速修正,請閱讀規則的訊息,並在您可以的話加以修正。 如果您不確定如何修正此問題,編輯器可以在檢閱您的PR時提出建議。
修正語法問題
當您在程式代碼空間中檢閱文章時,Markdownlint 會在您開啟文章及鍵入時自動進行檢查。 如果 Markdownlint 發現任何語法問題,則會在文件中以彩色波浪線標示它們。
將滑鼠停留在違規上方,以查看其詳細資訊。 若要開啟說明規則的網頁,請在暫留資訊中選取規則的標識碼。
如果規則支援快速修正,您可以在違規的懸停資訊中選取「快速修正...」,並從右鍵選單中選取建議的修正來套用。 您也可以按 Ctrl+。當您的 游標位於反白顯示的問題時,如果規則支援,則套用快速修正。
如果規則不支援快速修正,請閱讀規則的訊息,並在您可以的話加以修正。 如果您不確定如何修正此問題,編輯器可以在檢閱您的PR時提出建議。
您也可以將修正套用至文章中的所有語法違規。 若要這樣做,請開啟命令選擇區並輸入 Fix all supported markdownlint violations in the document
。 當您輸入時,命令選擇區會篩選可用的命令。 請選擇「修正文件中所有支援的 Markdownlint 違規」命令。 當您這麼做時,Markdownlint 會更新文件,以解決任何有快速修正的違規問題。
格式化數據表
若要格式化 Markdown 表格,請將游標放在 Markdown 的表格中或上。 開啟命令選擇區並搜尋 Table: Format Current
命令。 當您選取該命令時,它會更新數據表的 Markdown 以對齊並填補數據表,以改善可讀性。
它會轉換如下定義的資料表:
| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |
翻譯為:
| foo | bar | baz |
| :---: | :--- | ---: |
| a | b | c |
插入警示
文檔使用 警示 以使讀者更注意信息。
若要插入警示,您可以開啟命令選擇區並搜尋 Learn: Alert
命令。
當您選取該指令時,它會開啟內容選單。 選取您要新增的警示類型。 當您這樣做時,命令會將警示的 Markdown 插入檔中的游標。
將標題以句子式大小寫編排
若要轉換標題的大小寫,請反白顯示標題的文字,但前置 #
符號除外,以設定標題層級。 當您醒目提示文字時,請開啟 [命令選擇區],然後搜尋 Change case sentence
命令。 當您選取該命令時,它會轉換醒目提示文字的大小寫。
您也可以針對檔案中的任何文字使用大小寫命令。
開啟命令選擇區
您可以使用 VS Code 的 命令選擇區 來執行許多實用的命令。
若要在UI中開啟命令選擇區,請在頂端功能表欄中選取 [檢視]。 然後選取「指令面板...」在右鍵選單中。
若要使用鍵盤來開啟指令選擇區,請按作業系統的按鍵組合:
- Windows 和 Linux: Ctrl+Shift+P
- macOS: Cmd+Shift+P
預覽您的貢獻
若要預覽您的參與,請開啟命令選擇區並搜尋 Markdown: Open Preview
命令。 當您選取該命令時,VS Code 會開啟正在使用的文件的預覽。 預覽的樣式符合 Learn 平臺。
備註
網站相對路徑和交叉參考鏈接無法在預覽中正常運作。
重新調整內容布局
若要限制檔中段落的行長度,請將游標放在段落上。 然後開啟命令選擇區並搜尋 Reflow Markdown
命令。 當您選取命令時,它會將目前段落的行長度更新為設定的長度。 針對我們的存放庫,該長度為99個字元。
針對區塊引號使用此命令時,請確定您重排的區塊引號中的段落會以空白行括住。 否則,命令會將每個段落重排在一起。
謹慎
編輯文章時請勿使用此命令。 這些檔中的行不得超過80個字元。 存放庫目前沒有辦法依資料夾或檔名設定不同的行長度,因此重新排流不適用於文章檔。
檢閱文件中的所有問題
若要檢閱檔中的所有語法和樣式規則違規,請開啟 [問題檢視]。
若要在UI中開啟 [問題檢視],請在頂端功能表欄中選取 [檢視]。 然後在內容功能表中選取 [問題]。
若要使用鍵盤開啟問題檢視,請按下對應於您的作業系統的按鍵組合:
- Windows 和 Linux: Ctrl+Shift+M
- macOS: Cmd+Shift+M
[問題檢視] 會顯示開啟檔的所有錯誤、警告和建議。 請選擇問題,以捲動到文件中的該問題。
您可以依類型或文字比對來篩選問題。
更新 ms.date 元數據
若要更新 ms.date
文章的元數據,請開啟命令選擇器並搜尋 Learn: Update "ms.date" Metadata Value
命令。 當您選取命令時,它會將元數據更新為目前的日期。
其他資源
本文所述的工作和命令並不涵蓋您可以使用 VS Code 或已安裝的擴充功能執行的所有作業。
如需使用 VS Code 的詳細資訊,請參閱下列文章:
如需已安裝擴充功能的詳細資訊,請參閱其檔: