AsciiDoc 구문 참조

AsciiDoc은 AWS 설명서에 선호되는 마크업 언어입니다. 이 도구는 마크다운 구문(예: 제목 및 목록)을 부분적으로 지원하지만 일관성과 적절한 렌더링을 보장하기 위해 모든 콘텐츠에 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

Links

링크 서식을 올바르게 지정하는 방법에 대한 자세한 내용은 링크 삽입을 참조하세요. 마크다운 스타일 링크는 지원되지 않습니다.

코드 예제

인라인 코드

인라인 코드에 백틱을 사용합니다.

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*.

...