您可以在Cloud Shell中編寫和啟動教程,以協助使用者快速的熟悉您的專案。
單擊開啟 Cloud Shell 教程模式。教程模式下,使用者可以直接單擊協助文檔中的命令列,在 Cloud Shell 中運行。
步驟一:建立教程檔案
完成以下操作,建立儲存教程文檔的檔案夾:
- 在Cloud Shell中建立一個檔案夾用來儲存建立的教程文檔。
樣本
mkdir tutorials
- 在檔案夾根目錄中添加一個Markdown檔案,比如
tutorial.md
。touch tutorial.md
步驟二:編寫教程
您可以使用Markdown文法來編寫教程文檔。在編寫教程時,請遵循以下約定:
- H1 (#) 為教程標題。一個教程文檔中僅能有一個H1標題。
H2 (##) 為步驟標題。
您可以使用Markdown中的code文法在文檔中增加一段代碼。最終在您的教程文檔中會渲染成一個代碼塊,並且帶有一個複製按鈕,單擊會複製內容到Cloud Shell輸入位置上。
```bash aliyun help ```
您可以使用 Cloud Shell 教程提供的目錄指令,來為您的教程產生對應的目錄結構。
<tutorial-nav></tutorial-nav>
您可以使用 Cloud Shell 教程提供的開啟檔案的指令,來為您的教程添加開啟特定檔案的連結,使用者在瀏覽您的教程時,單擊該連結時,會在 Cloud Shell 編輯器中開啟該檔案。
<tutorial-editor-open-file filePath="path/test.md>Open File</tutorial-editor-open-file>
需要注意的是,您的檔案需要存放於
$HOME
目錄或者其子目錄中,指令中提供的filePath
可以是絕對路徑或者相對路徑,其中相對路徑需要相對於您的$HOME
目錄。
參考以下樣本,建立您的教程文檔。您可以通過vim命令編寫,也可以使用Cloud Shell的文字編輯器編寫教程。
# 使用阿里雲CLI來管理雲資源
## 查看阿里雲 CLI 協助資訊
```bash
aliyun help
```
### 首先
相關說明
### 然後
相關說明
```bash
echo world
```
## 恭喜完成教程
恭喜完成了學習如何使用阿里雲 CLI的教程。
步驟三:發布教程
完成以下操作,發布教程:
- 在git push之前,您可以使用如下命令來預覽測試您編寫的教程,以檢查是否還存在問題。
teachme tutorial.md
- 編寫完成後,您就可以使用Cloud Shell內建的Git命令,將您的教程作為一個Git倉庫,推送到您使用的Git中。 說明 您需要將倉庫推送到一個公網可訪問的倉庫中。否則閱讀您的教程的使用者,可能無法將倉庫clone到Cloud Shell中。