2. Markdown 수준의 AsciiDoc 표현
이 장에서는 일반적인 Markdown 문서에서 사용하는 표현을 AsciiDoc으로 작성하는 방법을 예제로 살펴봅니다. 표와 작업 목록처럼 Markdown 구현체에 따라 확장 기능으로 제공되는 표현도 별도 절에서 다룹니다.
Asciidoctor는 Markdown 방식의 제목, 인용문, 코드 펜스, 구분선 일부도 인식하지만, 여기서는 이식성이 높은 AsciiDoc 고유 문법을 사용합니다.
제목과 문서 구조
AsciiDoc은 등호(=) 개수로 제목 수준을 나타냅니다.
문서 제목은 등호 하나, 1단계 절은 등호 두 개로 시작합니다.
= 문서 제목
== 1단계 절
=== 2단계 절
==== 3단계 절이 장의 제목과 각 절 제목도 같은 문법으로 작성되어 있습니다.
하위 절 예제
등호를 하나 더 붙이면 현재 절의 하위 절을 만듭니다.
문단과 줄바꿈
연속된 텍스트 줄은 하나의 문단이 됩니다. 빈 줄을 하나 이상 넣으면 새 문단이 시작됩니다.
첫 번째 문단입니다. 원본에서 이 문장을 두 줄로 나누어 작성해도 출력에서는 한 문단으로 이어집니다.
빈 줄 뒤에서 두 번째 문단이 시작됩니다.
Markdown의 강제 줄바꿈에 해당하는 표현이 필요하면 줄 끝에 공백과 더하기 기호(+)를 씁니다.
첫 번째 줄입니다. +
두 번째 줄입니다.첫 번째 줄입니다.
두 번째 줄입니다.
인라인 서식
단어 또는 구를 꾸밀 때 다음 문법을 사용합니다.
| 표현 | AsciiDoc 원문 | 렌더링 결과 |
|---|---|---|
굵게 |
|
중요한 내용 |
기울임 |
|
강조할 내용 |
고정폭 |
|
|
굵은 기울임 |
|
매우 중요한 내용 |
취소선 |
|
삭제할 내용 |
문장 안의 단어 일부만 꾸밀 때는 표시 문자를 두 개씩 사용합니다. 예를 들어 `**A**sciiDoc`은 AsciiDoc으로, `문서__화__`는 문서화로 표시됩니다.
인용문
간단한 인용문은 [quote] 블록과 밑줄 네 개로 작성합니다.
저자와 출처도 블록 속성으로 함께 기록할 수 있습니다.
[quote, 작성자, 출처]
____
좋은 문서는 독자가 필요한 정보를 빠르게 찾도록 돕습니다.
____좋은 문서는 독자가 필요한 정보를 빠르게 찾도록 돕습니다.
출처
목록
순서 없는 목록
별표 개수로 목록의 중첩 수준을 나타냅니다.
* 첫 번째 항목
* 두 번째 항목
** 두 번째 항목의 하위 항목
** 또 다른 하위 항목
* 세 번째 항목-
첫 번째 항목
-
두 번째 항목
-
두 번째 항목의 하위 항목
-
또 다른 하위 항목
-
-
세 번째 항목
순서 있는 목록
마침표 개수로 순서 있는 목록의 중첩 수준을 나타냅니다. 번호는 변환기가 자동으로 계산합니다.
. 준비하기
. 작성하기
.. 초안 작성
.. 내용 검토
. 배포하기-
준비하기
-
작성하기
-
초안 작성
-
내용 검토
-
-
배포하기
작업 목록
작업 목록은 GitHub Flavored Markdown 등에서 널리 쓰이는 확장 표현에 대응합니다.
* [x] 목차 구성
* [x] 본문 작성
* [ ] 최종 검토-
✓ 목차 구성
-
✓ 본문 작성
-
❏ 최종 검토
링크와 교차 참조
URL 뒤의 대괄호에 링크 문구를 넣습니다. URL만 작성하면 자동 링크가 되며, 문서 안의 위치는 교차 참조로 연결합니다.
https://asciidoctor.org[Asciidoctor 웹사이트]
https://asciidoctor.org
<<basic-formatting,인라인 서식 절로 이동>>이미지
블록 이미지는 image::, 문장 안의 인라인 이미지는 image: 매크로로 삽입합니다.
대괄호의 첫 번째 값은 이미지 대체 텍스트입니다.
image::cover.png[예시 도서 표지,width=240]
코드
짧은 코드나 파일 이름은 백틱으로 감쌉니다. 예를 들어 `bundle exec asciidoctor book.adoc`처럼 표시할 수 있습니다.
여러 줄 코드는 [source,언어] 속성과 하이픈 네 개로 감쌉니다.
[source,ruby]
----
message = 'Hello, AsciiDoc!'
puts message
----message = 'Hello, AsciiDoc!'
puts message표
표는 일부 Markdown 구현체에서 확장 문법으로 제공되지만 AsciiDoc에서는 기본 문법입니다. `options="header"`를 지정하면 첫 번째 행을 머리글로 사용합니다.
[cols="1,2,1",options="header"]
|===
|항목 |설명 |상태
|제목
|문서의 구조를 구분합니다.
|완료
|목록
|여러 항목을 순서대로 나열합니다.
|완료
|===| 항목 | 설명 | 상태 |
|---|---|---|
제목 |
문서의 구조를 구분합니다. |
완료 |
목록 |
여러 항목을 순서대로 나열합니다. |
완료 |
각주
구분선
작은따옴표 세 개만 있는 줄은 문맥이 바뀌는 지점에 구분선을 삽입합니다.
구분선 앞의 내용입니다.
'''
구분선 뒤의 내용입니다.구분선 앞의 내용입니다.
구분선 뒤의 내용입니다.