AsciiDoc
GitLab은 Asciidoctor gem을 사용하여 AsciiDoc 콘텐츠를 HTML5로 변환합니다. AsciiDoc에 대한 완전한 참조는 Asciidoctor 사용자 매뉴얼을 참조하십시오.
다음 영역에서 AsciiDoc을 사용할 수 있습니다:
- 위키 페이지
- 리포지터리 내부의 AsciiDoc 문서(
.adoc또는.asciidoc)
구문
다음은 가장 일반적으로 사용되는 AsciiDoc 구문에 대한 간단한 참조입니다. AsciiDoc 구문의 전체 문서는 https://asciidoctor.org/docs/에서 찾을 수 있습니다.
단락
보통 단락.
줄 바꿈은 유지되지 않습니다.
//로 시작하는 줄 주석은 건너뜁니다:
// 이것은 주석입니다
빈 줄은 단락을 구분합니다.
[%hardbreaks] 옵션이 있는 단락은 줄 바꿈을 유지합니다:
[%hardbreaks]
이 단락은 `hardbreaks` 옵션을 가지고 있습니다.
이제 줄 바꿈이 보존되는 것을 확인하세요.
들여쓴(문자 그대로의) 단락은 텍스트 서식을 비활성화하고, 공백과 줄 바꿈을 보존하며 고정폭 글꼴로 표시됩니다:
이러한 문자 그대로의 단락은 한 칸 들여쓰여 있습니다.
따라서 *텍스트 서식*, 공백,
및 줄 바꿈이 보존됩니다.
규모 지시 단락은독자의 주의를 끕니다:
NOTE: 이것은 간략한 참조입니다. 전체 문서를 https://asciidoctor.org/docs/ 에서 읽어주십시오.TIP: 디렉터리을 들여쓸 수 있습니다. 선행 공백은 중요하지 않습니다.
텍스트 서식
제한된(단어 경계에 적용됨)
*강조된 중요성* (또는 볼드)
_강조된 강조_ (또는 이탤릭체)
`고정폭` (또는 타자 텍스트)
"`이중`"과 '`싱글`' 인용 부호
+passthrough 텍스트+ (치환비활성화됨)
`+문자 그대로 텍스트+` (치환 비활성화된 고정폭)
제한되지 않은(어디에나 적용됨)
**C**reate+**R**ead+**U**pdate+**D**elete
fan__freakin__tastic
``mono``culture
치환
A long time ago in a galaxy far, far away...
(C) 1976 Arty Artisan
I believe I shall--no, actually I won't.
매크로
// 여기서 c=specialchars, q=quotes, a=attributes, r=replacements, m=macros, p=post_replacements
유럽 아이콘:flag[role=blue]는 파랗고 앞면에는 패스:[************]가 있는 아이콘:circle-o[role=yellow]을 포함합니다.
pass:c[->] 연산자는 종종 stabby 람다로 불립니다.
AsciiDoc에서 `pass:[++]`가 높은 우선순위를 가지기 때문에 pass:c,a,r[C++ => C{pp}]로 다시 쓸 수 있습니다.
// 문서 헤더에 `:stem:`을 추가하여 스템 지원 활성화
stem:[sqrt(4) = 2]
속성
사용자 정의 속성
// 문서 헤더에서 속성을 정의합니다.
:name: 값
:url-gem: https://rubygems.org/gems/asciidoctor
당신은 Asciidoctor {asciidoctor-version}를 {url-gem}에서 다운로드하고 설치할 수 있습니다.
C{pp}는 필요하지 않으며, 루비만 필요합니다.
칡호가 홑이딘 단수 닫아진 중괄호 안의 단어를 출력하려면 앞에 백슬래시를 사용하여 \{name}처럼 해야합니다.
환경 속성
GitLab은 다음 환경 속성을 설정합니다:
| 속성 | 설명 |
|---|---|
docname
| 소스 문서의 루트 이름(선행 경로 또는 파일 확장명 없음). |
outfilesuffix
| 백엔드 출력에 해당하는 파일 확장명(문서 간 상호 참조가 작동하도록 기본적으로 .adoc로 설정됨).
|
링크
https://example.org/page[웹페이지]
link:../path/to/file.txt[로컬 파일]
xref:document.adoc[동료 문서]
mailto:hello@example.org[안녕하세요 메일]
앵커
[[idname,참조 텍스트]]
// 또는 일반 블록 속성으로 작성된 것으로 `[#idname,reftext=참조 텍스트]`
앵커(또는 ID)와 참조 텍스트가 있는 단락
<<idname>> 또는 <<idname,내부 링크의 선택적 텍스트>>를 참조하세요.
xref:document.adoc#idname[다른 문서에 있는 앵커로 이동합니다].
이 단락에는 주석이 있습니다.footnote:[주석의 내용입니다.]
디렉터리
순서 없는
* 레벨 1
** 레벨 2
*** 레벨 3
**** 레벨 4
***** 레벨 5
* 레벨 1로 돌아가기
+
열린 블록에 적용된 디렉터리 연속을 사용하여 디렉터리 항목에 블록 또는 단락을 첨부할 수 있습니다.
몇몇 작가
[circle]
- Edgar Allen Poe
- Sheri S. Tepper
- Bill Bryson
순서가 있는
. 단계 1
. 단계 2
.. 단계 2a
.. 단계 2b
. 단계 3
로마 숫자를 기억하세요?
[upperroman]
. 하나
. 둘
. 셋
체크리스트
* [x] 체크됨
* [ ] 체크되지 않음
Callout
// 문서 헤더에 `:icons: font`를 추가하여 callout 말풍선을 활성화합니다.
[,루비]
----
puts 'Hello, World!' # <1>
----
<1> 콘솔에 `Hello, World!`를 출력합니다.
설명
첫 번째 용어:: 첫 번째 용어의 설명
두 번째 용어::
두 번째 용어의 설명
문서 구조
헤더
= 문서 제목
저자 이름 <author@example.org>
v1.0, 2019-01-01
섹션
= 문서 제목 (레벨 0)
== 레벨 1
=== 레벨 2
==== 레벨 3
===== 레벨 4
====== 레벨 5
== 레벨 1로 돌아가기
포함
.asciidoc 파일 확장명으로 저장됩니다. AsciiDoc 위키 페이지를 사용할 때는 .adoc에서 .asciidoc로 파일 이름을 바꿉니다.include::basics.adoc[]
시스템 성능을 보장하고 악의적인 문서가 문제를 야기하는 것을 방지하기 위해, GitLab은 문서당 처리되는 포함 지시의 최대 제한을 강제합니다. 기본적으로 문서당 최대 32개의 포함 지시가 있을 수 있으며 이는 추이적 의존성을 포함합니다. 처리되는 포함 지시의 수를 사용자 지정하려면 애플리케이션 설정 API에서 asciidoc_max_includes 애플리케이션 설정을 변경하십시오.
asciidoc_max_includes의 현재 최대 허용값은 64입니다. 값이 너무 높으면 일부 상황에서 성능 문제가 발생할 수 있습니다.별도의 페이지 또는 외부 URL에서 포함을 사용하려면 애플리케이션 설정에서 allow-uri-read를 활성화하십시오.
// 애플리케이션 설정 allow-uri-read를 true로 설정하여 URI에서 콘텐츠를 읽을 수 있도록 활성화합니다.
include::https://example.org/installation.adoc[]
블록
--
open - 일반적인 콘텐츠 래퍼; 디렉터리 항목에 연결할 콘텐츠를 둘러싸는 데 유용합니다
--
// CAUTION, IMPORTANT, NOTE, TIP, and WARNING과 같은 인식된 유형이 있습니다.
// 문서 헤더에서 `:icons: font`를 설정하여 주의 아이콘을 활성화합니다
[NOTE]
====
주의 - 팁에서 경고까지 독자를 위한 주의사항
====
====
예제 - 문서화되는 개념의 데모
====
.Toggle Me
[%collapsible]
====
축소 가능 - 제목을 클릭하여 이 상세 정보를 표시합니다
====
****
sidebar - 본문 콘텐츠와 독립적으로 읽을 수 있는 보조 콘텐츠
****
....
literal - 프로그램 출력을 특징으로 하는 전시품
....
----
listing - 프로그램 입력, 소스 코드 또는 파일 내용을 특징으로 하는 전시품
----
[,language]
----
source - (컬러) 구문 강조가 적용된 리스트 항목
----
\```language
fenced code - 소스 블록의 간략한 구문
\```
[,attribution,citetitle]
____
quote - 인용문 또는 발췌; 출처와 제목은 선택 사항
____
[verse,attribution,citetitle]
____
verse - 문학적으로 발췌한 것, 종종 시; 출처와 제목은 선택 사항
____
++++
pass - 출력 문서로 직접 전달되는 내용; 종종 로우 HTML
++++
// 문서 헤더에 `:stem:`를 추가하여 스템 지원을 활성화합니다
[stem]
++++
x = y^2
++++
////
comment - 출력 문서에 포함되지 않는 내용
////
테이블
.Table 속성
[cols=>1h;2d,width=50%,frame=topbot]
|===
| 속성 이름 | 값
| options
| header,footer,autowidth
| cols
| colspec[;colspec;...]
| grid
| all \| cols \| rows \| none
| frame
| all \| sides \| topbot \| none
| stripes
| all \| even \| odd \| none
| width
| (0%..100%)
| format
| psv {vbar} csv {vbar} dsv
|===
색상
HEX, RGB, 또는 HSL 형식으로 색상을 지정하여 색상 표시기로 렌더링할 수 있습니다.
지원되는 형식(이름이 지정된 색상은 지원되지 않음):
-
HEX:`#RGB[A]`또는`#RRGGBB[AA]` -
RGB:`RGB[A](R, G, B[, A])` -
HSL:`HSL[A](H, S, L[, A])`
역따옴표로 둘러싸인 색상 뒤에 색상 “칩”이 옵니다:
- `#F00`
- `#F00A`
- `#FF0000`
- `#FF0000AA`
- `RGB(0,255,0)`
- `RGB(0%,100%,0%)`
- `RGBA(0,255,0,0.3)`
- `HSL(540,70%,50%)`
- `HSLA(540,70%,50%,0.3)`
방정식과 공식 (STEM)
과학, 기술, 공학, 수학 (STEM) 표현을 포함해야 하는 경우 문서의 헤더에서 stem 속성을 latexmath로 설정하세요.
방정식과 공식은 KaTeX을 사용하여 렌더링됩니다:
:stem: latexmath
latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon]
[stem]
++++
sqrt(4) = 2
++++
행렬은 stem:[[[a,b\],[c,d\]\]((n),(k))]. 로 작성할 수 있습니다.
다이어그램 및 플로차트
GitLab에서 텍스트로 다이어그램과 플로차트를 생성할 수 있습니다 Mermaid 또는 PlantUML을 사용하여.
Mermaid
자세한 내용은 공식 페이지를 방문하세요. Mermaid 사용이 처음이거나 Mermaid 코드의 문제를 식별하는 데 도움이 필요한 경우, Mermaid Live Editor은 Mermaid 다이어그램을 만들고 문제를 해결하는 데 도움이 되는 도구입니다.
다이어그램 또는 플로차트를 생성하려면 mermaid 블록에 텍스트를 입력하세요:
[mermaid]
----
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
----
Kroki
Kroki는 12개 이상의 다이어그램 라이브러리를 지원합니다. GitLab에서 Kroki를 사용하려면 먼저 GitLab 관리자가 이를 활성화해야 합니다. Kroki 통합 페이지에서 자세히 읽어보세요.
Kroki가 활성화되면 AsciiDoc 및 Markdown 문서에서 다이어그램을 만들 수 있습니다. 다음은 GraphViz 다이어그램을 사용하는 예시입니다:
AsciiDoc
[graphviz]
....
digraph G {
Hello->World
}
....
Markdown
```graphviz
digraph G {
Hello->World
}
```
PlantUML
GitLab.com에서 PlantUML 통합이 활성화되어 있습니다. Self-Managed 설치의 GitLab에서 PlantUML을 사용하려면, GitLab 관리자가 이를 활성화해야 합니다.
PlantUML이 활성화되면 plantuml 블록에 텍스트를 입력하세요:
[plantuml]
----
Bob -> Alice : hello
----
멀티미디어
image::screenshot.png[block image,800,450]
이미지를 다시로드하려면 press image:reload.svg[reload,16,opts=interactive]를 누르세요.
video::movie.mp4[width=640,start=60,end=140,options=autoplay]
GitLab은 AsciiDoc 콘텐츠에 YouTube 및 Vimeo 비디오를 임베드하는 것을 지원하지 않습니다. 표준 AsciiDoc 링크를 사용하세요:
https://www.youtube.com/watch?v=BlaZ65-b7y0[동영상에 대한 링크 텍스트]
줄 바꿈
// 구분선 (수평 규칙이라고도 함)
---
// 페이지 나누기
<<<
도움말