在 Cloud Shell 中編寫教學課程

Cloud Shell 支援建立和啟動教學課程，協助使用者快速有效地熟悉您的專案。

教學課程是一組以 Markdown 撰寫的指示。Cloud Shell 會將文字剖析為步驟和子步驟，並將這些步驟顯示在 Google Cloud 主控台的面板中，藉此根據這些 Markdown 檔案建立相關教學課程。

在 Cloud Shell 中執行的教學課程

編寫教學課程

教學課程是以 CommonMark Markdown 撰寫。支援其他Markdown 擴充功能和指令，其中包含精選功能和新增內嵌圖示等進階功能。

步驟

建立教學課程時，標題對於決定課程結構至關重要。如要設定正確的標題、步驟標題和基礎操作說明，請使用下列階層：

  • 教學課程標題的 H1 (#) 標記。教學課程中只能有一個 H1 標記。
  • H2 (##) 標記適用於步驟標題。
  • H3 (###) 標記適用於子步驟標題。

以下是您可以用來製作教學課程的範例 Markdown 檔案：

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

指令

指令可啟用進階功能，例如聚焦功能和新增內嵌圖示。

如要新增指令，請使用下列格式：

<walkthrough-DIRECTIVE_NAME PARAMETER="PARAMETER_VALUE">
</walkthrough-DIRECTIVE_NAME>

舉例來說，如果您想使用指令 editor-open-file 和參數 filePath，則會寫成以下格式：

<walkthrough-editor-open-file filePath="test/hello.md">
</walkthrough-editor-open-file>

如需可用的指令，請參閱指令參考資料。

在 Cloud Shell 中啟動教學課程

在 Cloud Shell 中啟動教學課程的方法有兩種：

  1. 使用 cloudshell launch-tutorial 指令

    在 Cloud Shell 工作階段中執行下列 cloudshell 指令，透過現有的 Markdown 檔案 tutorial.md 啟動教學課程：

    cloudshell launch-tutorial tutorial.md

    或者，您也可以使用 teachme 別名，方法是在 Cloud Shell 工作階段中執行下列指令，透過現有的檔案 hello.md 啟動教學課程：

    teachme hello.md

  2. 使用「在 Cloud Shell 中開啟」

    或者，您也可以使用「在 Cloud Shell 中開啟」功能，引導使用者從網站、網誌或開放原始碼專案，前往您在 Git 存放區中代管的教學課程。「在 Cloud Shell 中開啟」功能可使用 cloudshell_tutorial 參數，可新增至網址結尾，用於指定原始 Markdown 檔案在儲存庫中的所在位置。也就是說，連結至教學課程的按鈕的 Markdown 會如下所示：

    [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://ssh.cloud.google.com/cloudshell/open?cloudshell_git_repo=GIT_REPO_URL&cloudshell_tutorial=PATH_TO_MD_FILE)

後續步驟