教學課程:Markdown 參考資料

Cloud Shell 教學課程,又稱逐步操作說明,可讓使用者以快速有效的方式熟悉您的專案,並且輕鬆執行各項設定和啟動作業。Cloud Shell 教學課程是以 CommonMark Markdown 編寫而成的一系列操作說明,其中也包含教學課程專用的 Markdown 運算式指令,這些指令可用於新增焦點和專案選項等進階功能。

請參閱編寫教學課程指南,瞭解如何在 Cloud Shell 中設定、撰寫及啟用教學課程。

指令格式

如要新增指令,請使用下列格式:

<walkthrough-directive-name param-name="param-value">
</walkthrough-directive-name>

Cloud Shell 指令

下表列出多個指令和相對應的參數,您在撰寫 Cloud Shell 教學課程時可以參考使用。

教學課程中繼資料和版面配置

作者

作者標記會定義與作者有關的中繼資料,這項標記的所有參數皆為選用參數。

author 建立教學課程作者的相關中繼資料。
name 作者的姓名。
repositoryUrl 連結至意見回饋所用的存放區。
tutorialName 教學課程 ID

教學課程時間長度

教學課程時間長度標記會產生一個時鐘圖示,以及顯示教學課程預估時間長度的訊息。

tutorial-duration 顯示教學課程的時間長度。
duration 教學課程的預估時間長度 (以分鐘為單位)。

教學課程資訊卡

教學課程資訊卡標記會連結至相關的推薦教學課程。

tutorial-card 顯示推薦的教學課程。
url 教學課程的網址。
icon 圖示名稱。
label 點擊事件數據分析的標籤。

註腳

註腳指令會將文字內容設為顯示於步驟底部的註腳。

您必須以內文的形式撰寫註腳文字。

footnote 會以註腳的形式呈現文字內容。

專案選項

專案設定

專案設定程序可協助使用者建立或選取要使用的專案。使用者必須選取有效的專案,這項步驟才會允許他們繼續操作。

專案權限標記會設定教學課程所需的專案權限。如果使用者未具備所選專案的相關權限,專案設定程序就不會將其視為有效的專案。

如需專案權限運作方式的相關說明,請參閱這份說明文件

project-setup 改用專案設定程序。
permissions (選用) 以逗號分隔的必要權限清單。

專案與帳單設定

專案與帳單設定程序可協助使用者建立或選取要使用的專案。使用者必須選取已啟用計費功能的有效專案,這項步驟才會允許他們繼續操作。

project-billing-setup 改用必須啟用計費功能的專案設定程序。
permissions (選用) 以逗號分隔的必要權限清單。

焦點與按鈕

焦點指標

焦點指標指令會建立可點選的標籤,以便您強調畫面上的特定 UI 元素。在下列參數中,您只需要設定其中一項參數。如果您同時設定了兩項參數,系統只會使用 spotlightId

指標可以依據實作項目 ID (一種 DOM 元素屬性) 或使用 CSS 選取器來選取元素。無論選擇何種選取方式,您都可以使用以逗號分隔的選取條件來配對不同元素,與選取條件相符的所有元素皆會以醒目的方式呈現。

您必須以內文的形式撰寫標籤文字。

spotlight-pointer 改用焦點指標。
spotlightId 實作項目 ID,您可以使用逗號來分隔多組 ID。
cssSelector CSS 選取器
GCP Console 焦點目標 說明
console-nav-menu 主控台導覽選單,位於畫面左上方的三線選單。
devshell-activate-button 開啟 Cloud Shell 的按鈕,靠近畫面右上方。
devshell-web-editor-button 開啟 Orion 編輯器的按鈕,位於 Cloud Shell 的頂端列。
devshell-web-preview-button 在網頁中開啟 Cloud Shell 預覽視窗的按鈕。

啟用 API

API 啟用程序可產生按鈕,使用者只要點選這個按鈕就能啟用 API。這樣一來,您的專案就能存取 GCP 的 API。

如要查看自己可以啟用哪些 API,請參閱這份說明文件

enable-apis 顯示啟用 API 的程序。
apis 要啟用的 API 清單 (以逗號分隔)。

開啟 Cloud Shell

Cloud Shell 開啟程序可產生按鈕,使用者只要點選這個按鈕就能開啟 Cloud Shell。

open-cloud-shell-button 顯示開啟 Cloud Shell 的程序 (使用者選取的當前專案也會列於其中)。
open-cloud-shell 顯示主要步驟時一併開啟 Cloud Shell。
devshell-precreate 在背景中佈建 Cloud Shell 執行個體,以便加快載入速度。在顯示開啟 Cloud Shell 的步驟時,系統會一併執行這項作業。

動態變數

資料繫結

您在撰寫逐步操作說明時,可以使用鍵/值組合的資料繫結。使用者可以透過指令或教學課程架構設定這些值,也可以在教學課程中使用 watcher-constant 指令加以定義。

接下來,使用下列指令碼即可參照該字串值:

{{<key>}}

在 Markdown 中的應用實例如下:

# My Tutorial

## Step 1

<walkthrough-watcher-constant key="my-key" value="Hello Google">
</walkthrough-watcher-constant>

My message: {{my-key}}

您可以使用以下的內建鍵:

資料名稱 值說明
project-id 使用者目前專案的 ID。
project-name 使用者的專案名稱。

監看指令碼常數

您可以為教學課程設定「監看指令碼」這種動態字串,並使用「監看指令碼」常數來定義教學的初始值。詳情請參閱資料繫結一節。

watcher-constant 定義轉譯時間的字串值。
key 監看指令碼的鍵。
value 監看指令碼的值。

圖示指令

下列圖示的樣式為內嵌圖示。

指令 圖示
cloud-shell-icon Cloud Shell 圖示
web-preview-icon 網頁預覽圖示
cloud-shell-editor-icon Cloud Shell 編輯器圖示
nav-menu-icon 導覽選單圖示
notification-menu-icon 通知選單圖示
pin-section-icon 釘選選單專區圖示

您可以將下列圖示設為圖片。

指令 圖示
conclusion-trophy 教學課程完成獎盃

Cloud Shell 編輯器指令

Cloud Shell 編輯器頁面支援使用編輯器指令。

開啟檔案

開啟檔案的指令會建立可點選的標籤,方便使用者從 Cloud Shell 磁碟中開啟檔案。

您必須以內文的形式撰寫標籤文字。

editor-open-file 透過編輯器從 Cloud Shell 中開啟檔案。
filePath 相關檔案路徑

選取文字

選取文字的指令會建立可點選的標籤,方便使用者開啟檔案並選取檔案內文。

editor-select-line 在編輯器中選取特定文字。
filePath 相關檔案路徑
startLine 起始行
startCharacterOffset 起始索引
endLine 結束行
endCharacterOffset 結束索引
editor-select-regex 在編輯器中選取特定文字。
filePath 相關檔案路徑
regex 配對時使用的規則運算式

您必須以內文的形式撰寫標籤文字。

焦點指標

焦點指標指令會建立可點選的標籤,以便您強調畫面上的特定 UI 元素。

指標僅可選取預先定義的目標。

editor-spotlight 醒目顯示預先定義的目標。
spotlightId 編輯器 ID

您必須以內文的形式撰寫標籤文字。

編輯器焦點目標 說明
fileMenu 醒目顯示檔案選單按鈕。
editMenu 醒目顯示編輯選單按鈕。
navigator 醒目顯示項目欄位中指定的檔案。
本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Cloud Shell