AsciiDoc 구문 참조

AsciiDoc은 AWS 문서에서 선호하는 마크업 언어입니다. 도구가 Markdown 구문(제목, 목록 같은)을 부분 지원하지만, 일관성과 올바른 렌더링을 보장하려면 모든 콘텐츠에 AsciiDoc 구문을 사용할 것을 권장합니다.

이 가이드는 Amazon EKS 문서에 기여할 때 필요한 일반적인 구문 요소를 다룹니다. 더 고급 구문과 상세 정보는 AsciiDoc 문서를 참고하세요.

출처: 문서

본문

새 페이지 (New page)

모든 새 AsciiDoc 문서는 Create a new page에 정의된 구조로 시작해야 합니다.

제목 (Headings)

콘텐츠를 계층적으로 구성하려면 제목을 사용하세요.

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

참고: AWS 문서에서는 제목에 항상 sentence case(첫 단어만 대문자)를 사용하세요.

텍스트 서식 (Text formatting)

중요한 정보를 강조하려면 텍스트를 서식 지정합니다.

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)

링크를 올바르게 서식 지정하는 방법은 Insert a link를 참고하세요. Markdown 스타일 링크는 지원되지 않습니다.

코드 예시 (Code examples)

인라인 코드

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

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

코드 블록

구문 강조와 속성 지원(엔티티와 유사)으로 코드 블록을 만듭니다.

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

이미지 (Images)

접근성을 위한 alt 텍스트로 이미지를 삽입합니다.

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

표 (Tables)

정보를 정리하려면 표를 만듭니다.

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

|Cell 1,1
|Cell 1,2

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

더 복잡한 표는 AsciiDoc table 문서를 참고하세요.

콜아웃 (Callouts)

중요한 정보와 주의 사항을 강조하려면 콜아웃을 사용합니다.

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.

미리 보기: Note — This is a note callout.

다른 파일 포함

다른 파일의 콘텐츠를 포함합니다.

 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 파일을 참고하세요.

절차 (Procedures)

단계별 절차를 서식 지정합니다.

To create an Amazon EKS cluster, do the following steps.

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

...

AsciiDoc 구문 참조