インタラクティブな Markdown チュートリアルを作成して Git リポジトリに公開する - Cloud Shell - Alibaba Cloud - Cloud Shell

Cloud Shell でインタラクティブチュートリアルを作成して公開し、ユーザーがプロジェクトをすぐに使い始められるよう支援します。

クリックして Cloud Shell チュートリアルモードを開くと、ライブサンプルを確認できます。チュートリアルモードでは、ドキュメント内の任意のコマンドをクリックすると、Cloud Shell で直接実行できます。

ステップ 1：チュートリアルファイルの作成

Cloud Shell で、チュートリアルドキュメント用のディレクトリを作成します。

例
```
mkdir tutorials
```
新しいディレクトリに、tutorial.md などの Markdown ファイルを作成します。
```
touch tutorial.md
```

ステップ 2：チュートリアルの作成

Markdown 構文を使用してチュートリアルを作成し、次の規則に従ってください：

チュートリアルのタイトルには H1 見出し (#) を使用します。各チュートリアルドキュメントに含めることができる H1 見出しは 1 つだけです。
各ステップのタイトルには、H2 見出し (##) を使用します。
Markdown のコード構文を使用してコードスニペットを追加します。Cloud Shell はこれらをコピーボタン付きのコードブロックとしてレンダリングします。ボタンをクリックすると、コマンドが Cloud Shell ターミナルに直接貼り付けられます。
```
aliyun help 
```
<tutorial-nav> ディレクティブを使用して、チュートリアルのナビゲーション構造を生成します。
```
<tutorial-nav></tutorial-nav>
```
<tutorial-editor-open-file> ディレクティブを使用して、Cloud Shell テキストエディターで特定のファイルを開くリンクを追加します。
```
<tutorial-editor-open-file filePath="path/test.md">Open File</tutorial-editor-open-file>
```
ファイルは $HOME ディレクトリまたはそのサブディレクトリのいずれかに存在する必要があります。 filePath 属性には、絶対パスまたは相対パスを指定できます。 Cloud Shell は、相対パスを $HOME ディレクトリを基準に解決します。

チュートリアルを作成する際は、次の例を参考にしてください。vim コマンドまたは Cloud Shell テキストエディターを使用して作成します。

# Manage cloud resources using Alibaba Cloud CLI

## View Alibaba Cloud CLI help

aliyun help

### First Description

### Then Description

echo world

## Congratulations on completing the tutorial

Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI.

ステップ 3：チュートリアルの公開

git push を実行する前に、次のコマンドでチュートリアルをプレビューしてテストしてください。

teachme tutorial.md

shell@Alicloud:~/tutorials$ cat tutorial.md
# Manage cloud resources using Alibaba Cloud CLI
## View Alibaba Cloud CLI help
aliyun help
### First Description
### Then Description
echo world
## Congratulations on completing the tutorial
Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI.
shell@Alicloud:~/tutorials$ teachme tutorial.md

Cloud Shell に組み込まれている Git コマンドを使用して、チュートリアルをリモート Git リポジトリにプッシュしてください。

説明
Git リポジトリはパブリックである必要があります。プライベートの場合、ユーザーは Cloud Shell にクローンできません。