AsciiDoc 構文のリファレンス

AsciiDoc は AWS ドキュメントに推奨されるマークアップ言語です。ツールには Markdown 構文 (見出しやリストなど) が部分的にサポートされていますが、一貫性および適切なレンダリングを確保するため、すべてのコンテンツに AsciiDoc 構文を使用することをお勧めします。

このガイドでは、Amazon EKS ドキュメントに貢献する際に必要な一般的な構文要素について説明します。より高度な構文および詳細情報については、「AsciiDoc ドキュメント」を参照してください。

新しいページ

すべての新しい AsciiDoc ドキュメントは、新しいページを作成する で定義された構造で始まる必要があります。

ヘッダー

見出しを使用してコンテンツを階層的に整理してください。

= Page/topic title (level 1)
== Section title (level 2)
=== Level 3 heading
==== Level 4 heading
===== Level 5 heading
====== Level 6 heading

注: AWS ドキュメントの見出しには、必ずセンテンスケース (文頭のみ大文字) を使用してください。

テキストのフォーマット

テキストをフォーマットして重要な情報を強調します。

Use *bold text* for UI labels.
Use _italic text_ for introducing terms or light emphasis.
Use `monospace text` for code, file names, and commands.

Lists

順序付けられていないリスト

特定の順序がない項目には箇条書きリストを作成します。

* First item
* Second item
** Nested item
** Another nested item
* Third item

順序付けられたリスト

順序付けられたステップや優先順位の高い項目には、番号付きリストを作成します。

. First step
. Second step
.. Substep 1
.. Substep 2
. Third step

リンク

リンクを適切にフォーマットする方法の詳細については、「リンクを挿入する」を参照してください。Markdown 形式のリンクはサポートされていません。

コードの例

インラインコード

インラインコードにバックティックを使用します。

Use the `kubectl get pods` command to list all pods.

コードブロック

構文強調表示機能と属性サポート機能 (エンティティに類似) を持つコードブロックを作成します。

 [source,python,subs="verbatim,attributes"]
 ----
 def hello_world():
     print("Hello, World!")
 ----

イメージ

アクセシビリティのために代替テキストがある画像を挿入します。

image::images/image-file.png[Alt text description]

テーブル

テーブルを作成して情報を整理します。

[%header,cols="2"]
|===
|Header 1
|Header 2

|Cell 1,1
|Cell 1,2

|Cell 2,1
|Cell 2,2
|===

より複雑なテーブルについては、「AsciiDoc テーブルのドキュメント」を参照してください。

コールアウト

コールアウトを使用して重要な情報および勧告を強調表示します。

NOTE: This is a note callout for general information.

TIP: This is a tip callout for helpful advice.

IMPORTANT: This is an important callout for critical information.

プレビュー:

注記

これはメモのコールアウトです。

他のファイルを含める

他のファイルのコンテンツを含めます。

 include::filename.adoc[]

属性 (エンティティに類似)

事前定義された属性を使用して整合性を維持します。特に、AWS と arn:aws: には属性を使用する必要があります。

{aws} provides Amazon EKS as a managed Kubernetes service.

 [source,bash,subs="verbatim,attributes"]
 ----
 aws iam attach-role-policy \
     --role-name AmazonEKSAutoClusterRole \
     --policy-arn {arn-aws}iam::aws:policy/AmazonEKSClusterPolicy
 ----

属性のリストについては、「../attributes.txt」ファイルを参照してください。

手順

ステップバイステップの手順には以下の書式を使用します。

To create an Amaozon EKS cluster. do the following steps.

. Sign in to the {aws} Management Console.
. Open the Amazon EKS console.
. Choose *Create cluster*.

...