您可以在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中。