-
github 에서 열람시에는 정상적으로 적용되지 않는 문법들이 많이 있으니 참고하시기 바랍니다.
가이드에 포함될 adoc 파일에 문법을 적용하고 AsciiBinder로 빌드하면 정상적으로 출력됩니다.
제목은 크게 3가지 타입이 존재한다.
-
문서 제목
-
섹션 제목
-
블록 제목
== 기호를 사용해서 섹션 제목을 삽입할 수 있다. 만약 하위 레벨을 생성하려면 = 문자를 하나씩 추가한다.
== 섹션 제목 1 === 섹션 제목 1 : 레벨 2 ==== 섹션 제목 1 : 레벨 3 == 섹션 제목 2
문단은 빈줄로 구분할 수 있다. 빈줄이 없이 작성된 문장은 모두 연결되어 하나의 문단으로 구성된다.
사과는 빨간색이다. 바나나는 노란색이다. 오렌지는 주황색이다.
사과는 빨간색이다. 바나나는 노란색이다.
오렌지는 주황색이다.
줄 바꿈할 위치에 공백을 추가한 후 +를 입력한다.
사과는 빨간색이다. + 바나나는 노란색이다. + 오렌지는 주황색이다.
사과는 빨간색이다.
바나나는 노란색이다.
오렌지는 주황색이다.
텍스트에 굵게, 기울이기, 텍스트 박스 효과를 적용할 수 있다.
1. 굵게 *bold* 2. 기울이기 _italic_ 3. 텍스트 박스 `monospace` 4. 위 첨자 ^super^ 5. 아래 첨자 ~sub~
bold
italic
monospace
super
sub
|=== 기호를 사용해서 표를 삽입할 수 있다. 이때 각 컬럼은 |로 구분한다.
[width="100%", options="header"] |==================== |항목 |설명 |이름 |서비스의 이름 |시간 |생성된 시간 |====================
| 항목 | 설명 |
|---|---|
이름 |
서비스의 이름 |
시간 |
생성된 시간 |
cols 속성을 통해 열의 상대 너비를 조절한다.
[width="100%", options="header", cols="1,3"] |==================== |항목 |설명 |이름 |서비스의 이름 |시간 |생성된 시간 |====================
| 항목 | 설명 |
|---|---|
이름 |
서비스의 이름 |
시간 |
생성된 시간 |
---- 기호를 사용해서 소스 코드를 작성하기 위한 블럭을 생성할 수 있다. 이때 소스 코드 블럭 위에 [source] 블럭을 작성해서 문법을 강조할 언어를 지정할 수 있다. (예 : [source, ruby])
또한 코드 라인에 대한 설명이 필요할 경우 해당 라인 끝에 <숫자>를 입력하고, 소스 코드 블럭 아래에 설명을 입력한다.
[source, yaml] ---- apiVersion: servicecatalog.k8s.io/v1beta1 kind: ClusterServiceBroker metadata: name: hyperbroker4 <1> ---- <1> 코드 라인 설명 작성
apiVersion: servicecatalog.k8s.io/v1beta1
kind: ClusterServiceBroker
metadata:
name: hyperbroker4 (1)-
클러스터 서비스 브로커의 이름
목록을 표시할 때 글머리 기호를 사용한다.
글머리 기호는 * 문자를 사용해서 삽입할 수 있다. 만약 하위 레벨을 생성하려면 해당 문자를 하나씩 추가한다. 단, 레벨은 최대 3 단계까지 적용한다.
* 목록 1 : 레벨 1 ** 목록 1 : 레벨 2 *** 목록 1 : 레벨 3 * 목록 2 : 레벨 1 ** 목록 2 : 레벨 2 *** 목록 2 : 레벨 3
-
목록 1 : 레벨 1
-
목록 1 : 레벨 2
-
목록 1 : 레벨 3
-
-
-
목록 2 : 레벨 1
-
목록 2 : 레벨 2
-
목록 2 : 레벨 3
-
-
순서를 가진 목록을 표시할 때 번호 매기기를 사용한다.
번호 매기기는 . 문자를 사용해서 삽입할 수 있다. 만약 하위 레벨을 생성하려면 해당 문자를 하나씩 추가한다. 단, 레벨은 최대 2 단계까지 적용한다.
. 1 단계 .. 1-1 단계 .. 1-2 단계 . 2 단계 . 3 단계
-
1 단계
-
1-1 단계
-
1-2 단계
-
-
2 단계
-
3 단계
include:: 라벨을 사용해서 내부의 다른 문서를 현재 작업 중인 문서에 포함시킬 수 있다.
이때 leveloffset 옵션으로 포함된 문서의 레벨 조절이 가능하다.
include::home/status.adoc[] include::home/search.adoc[leveloffset=+1] include::home/event.adoc[leveloffset=+2]
link: 라벨을 사용해서 URL 주소를 클릭하면 링크되도록 설정할 수 있다.
이때 문서에 URL 주소 대신 메시지를 표시하려면 URL 주소 끝에 메시지를 대괄호([ ])로 묶는다.
link:https://tmaxcloud.com[TmaxCloud 포털]
xref: 라벨을 사용해서 다른 adoc 문서로 링크되도록 설정할 수 있다.
xref:../welcome/index.adoc[제품소개 페이지로 이동]
image:: 라벨을 사용해서 이미지를 삽입할 수 있다. 만약 텍스트 사이에 이미지를 삽일할 경우에는 image: 라벨을 사용한다.
1. 블록 형태의 이미지 삽입 image::images/figure_action_icon.png[] 2. 텍스트 사이에 이미지 삽입 이름 왼쪽의 image:images/figure_action_icon.png[]을 클릭하면 메뉴가 열린다.