Rocky 문서 포맷팅¶

이 가이드는 우리의 더 고급 포맷팅 옵션을 강조하며, 주의 사항, 번호 매긴 목록, 표 등을 포함합니다.

문서는 이러한 요소를 반드시 포함하지 않아도 됩니다. 특별한 포맷팅이 필요하다고 생각되면 이 가이드가 도움이 될 것입니다.

!!! !!!

Headings are not special formatting characters; rather they are standard markdown syntax. **단일** 레벨 1의 제목을 포함합니다:

```
# 이것은 레벨 1입니다
```


그리고 레벨 2부터 레벨 6까지의 여러 하위 제목 값을 포함할 수 있습니다:

```
## 레벨 2 제목
### 레벨 3 제목
#### 레벨 4 제목
##### 레벨 5 제목
###### 레벨 6 제목
```


중요한 점은 2에서 6까지의 제목을 필요한 만큼 사용할 수 있지만, 레벨 1의 제목은 **하나**만 사용해야 합니다. 레벨 1의 제목이 하나 이상인 경우 문서가 올바르게 표시되지만, 오른쪽에 나타나는 문서의 자동 생성된 목차가 올바르지 않게 표시되거나(때로는 전혀 표시되지 않음) 할 수 있습니다. 문서를 작성할 때 이 점을 염두에 두세요.

Admonition(경고)¶

경고는 중요한 사실에 주목할 수 있도록 특별히 디자인된 "상자"입니다. 경고 유형은 다음과 같습니다:

유형	설명
note	파란색 텍스트 상자를 렌더링합니다.
abstract	밝은 파란색 텍스트 상자를 렌더링합니다.
info	청록색 텍스트 상자를 렌더링합니다.
tip	청록색 텍스트 상자를 렌더링합니다(아이콘이 약간 더 녹색임).
success	녹색 텍스트 상자를 렌더링합니다.
question	연한 녹색 텍스트 상자를 렌더링합니다.
warning	주황색 텍스트 상자를 렌더링합니다.
failure	밝은 빨간색 텍스트 상자를 렌더링합니다.
danger	빨간색 텍스트 상자를 렌더링합니다.
bug	빨간색 텍스트 상자를 렌더링합니다.
example	보라색 텍스트 상자를 렌더링합니다.
quote	회색 텍스트 상자를 렌더링합니다.
custom ₁	항상 파란색 텍스트 상자를 렌더링합니다.
custom ₂	다른 유형 내에서 사용자 지정 제목을 사용합니다.

위의 custom ₁에 명시된 대로 사용할 수 있는 admonition(경고) 유형에는 제한이 없습니다. 위의 custom ₂에 설명된 대로 사용자 정의 제목을 다른 경고 유형에 추가하여 특정 주의사항에 대해 원하는 색상 상자를 얻을 수 있습니다.

주의사항은 항상 다음과 같이 입력됩니다.

!!! admonition_type (경고 유형)

    경고 내용

경고의 본문 텍스트는 시작 여백에서 4개의 공백 들여쓰기가 되어야 합니다. 이것은 경고 유형의 첫 글자와 항상 일치하게 됩니다. 제목과 본문 사이의 추가 줄은 나타나지 않지만 Crowdin 번역 엔진이 정확하게 작동하도록 필요합니다.

다음은 각 경고 유형의 예시와 문서에서의 모습입니다:

Note

text

Abstract

text

!!! !!!

text

Tip

text

Success

text

Question

text

Warning

text

Failure

text

Danger

text

!!! custom (사용자 정의)

custom <sub>1</sub> 유형. 여기서는 "custom"을 사용했습니다. 다시 말하지만, 이것은 항상 파란색으로 렌더링됩니다.

사용자 정의 제목

custom ₂ 유형. 여기에서 사용자 지정 헤더를 사용하여 "warning" 주의사항 유형을 수정했습니다. 다음과 같습니다:

!!! 경고 "사용자 정의 제목"

확장 가능한 주의사항¶

경고 내용이 매우 긴 경우, 확장 가능한 경고를 사용하는 것이 좋습니다. 이는 일반적인 경고와 동일하게 처리되지만, 세 개의 물음표로 시작하는 대신 세 개의 느낌표로 시작합니다. 다른 경고 규칙은 모두 여기에 적용됩니다. 확장 가능한 경고는 다음과 같이 보입니다:

경고 내용

내용이 많지 않은 경고입니다. 이에 대해 정기적인 주의사항을 사용하고 싶으시겠지만, 이것은 단지 예시일 뿐입니다!

편집기에서 다음과 같이 표시됩니다.

??? 경고 "경고 내용"

     내용이 많지 않은 경고입니다. 이에 대해 정기적인 주의사항을 사용하고 싶으시겠지만, 이것은 단지 예시일 뿐입니다!

문서 내의 탭으로 구분된 콘텐츠¶

탭으로 된 콘텐츠는 경고와 비슷한 방식으로 서식을 지정합니다. 세 개의 느낌표나 세 개의 물음표 대신, 세 개의 등호로 시작합니다. 모든 경고 서식(4개의 공백 등)이 이 콘텐츠에도 적용됩니다. 이러한 콘텐츠의 예시는 문서가 서로 다른 Rocky Linux 버전에 대해 다른 절차가 필요한 경우입니다. 버전에 대해 탭으로 된 콘텐츠를 사용할 때에는 최신 버전이 먼저 와야 합니다. 현재 기준으로 9.0이 그렇습니다:

9.08.6

9.0에서 이 작업을 수행하는 절차

8.6에서 이를 수행하는 절차

편집기에서 다음과 같이 표시됩니다.

=== "9.0"

     9.0에서 이 작업을 수행하는 절차

=== "8.6"

     8.6에서 이를 수행하는 절차

탭으로 된 섹션 내의 모든 내용은 섹션이 완료될 때까지 4개의 공백 들여쓰기를 계속해야 합니다. 이는 매우 유용한 기능입니다!

번호 매기기 목록¶

번호 매긴 목록은 만들고 사용하기 쉬운 것처럼 들리며, 한 번 익숙해지면 정말 쉽습니다. 단순히 복잡하지 않은 항목 목록만 있는 경우에는 다음과 같은 형식으로 작성하면 됩니다:

1. Item 1

2. Item 2

3. Item 3

Item 1
Item 2
Item 3

코드 블록, 여러 줄 또는 단락 텍스트를 번호 매긴 목록에 추가해야 할 경우 해당 텍스트는 admonition에서 사용한 것과 동일한 4개의 공백으로 들여쓰기 되어야 합니다.

이를 번호 매긴 항목 아래에 정렬하는 데 눈을 사용할 수 없으므로 공간 들여쓰기를 사용해야 합니다. 좋은 마크다운 편집기를 사용하는 경우 탭 값을 4로 설정하여 모든 서식을 조정하는 것이 조금 더 쉬워집니다.

다음은 여러 줄로 이루어진 번호 매긴 목록 예시와 코드 블록을 포함한 예시입니다:

번호 매긴 목록에 코드 블록 등 여러 줄이 포함된 경우 원하는 대로 공간 들여쓰기를 사용하세요.

예시: 이것은 4개의 공백으로 들여쓰기가 된 단락 텍스트입니다. 여기에 코드 블록을 추가합니다. 코드 블록도 같은 4개의 공백으로 들여쓰기되었습니다:
```
dnf update
```
두 번째 목록 항목입니다. 우리는 들여쓰기를 사용했기 때문에 다음 번호 매기기(다시 말해 2)으로 렌더링됩니다. 하지만 들여쓰기 없이 항목 1을 입력했다면(다음 단락과 코드에서), 다시 항목 1로 표시되어 원하는 결과가 아닙니다.

이것이 원시 텍스트로 표시되는 방식입니다:

1. 번호 매긴 목록에 코드 블록 등 여러 줄이 포함된 경우 공간 들여쓰기를 사용하세요.

    예시: 이것은 4개의 공백으로 들여쓰기가 된 단락 텍스트입니다. 여기에 코드 블록을 추가합니다. 코드 블록도 같은 4개의 공백으로 들여쓰기되었습니다:

    ```


    dnf update
    ```

2. 두 번째 목록 항목입니다. 우리는 들여쓰기를 사용했기 때문에 다음 번호 매기기(다시 말해 2)으로 렌더링됩니다. 하지만 들여쓰기 없이 항목 1을 입력했다면(다음 단락과 코드에서), 다시 항목 1로 표시되어 원하는 결과가 아닙니다.

테이블¶

표는 명령 옵션을 정렬하거나, 위의 예에서 보았듯이 주의 사항 유형과 설명을 정리하는 데 도움이 됩니다. 위의 주의 사항 섹션에 있는 표를 입력하는 방법은 다음과 같습니다:

| type      | Description                                               |
|-----------|-----------------------------------------------------------|
| note      | 파란색 텍스트 상자를 렌더링                               |
| abstract  | 밝은 파란색 텍스트 상자를 렌더링                          |
| info      | 청록색 텍스트 상자를 렌더링                               |
| tip       | 청록색 텍스트 상자를 렌더링합니다(아이콘이 약간 더 녹색)  |
| success   | 녹색 텍스트 상자를 렌더링                                 |
| question  | 밝은 녹색 텍스트 상자를 렌더링                            |
| warning   | 오렌지 텍스트 상자를 렌더링                               |
| failure   | 밝은 빨간색 텍스트 상자를 렌더링                          |
| danger    | 빨간색 텍스트 상자를 렌더링                               |
| bug       | 빨간색 텍스트 상자를 렌더링                               |
| example   | 보라색 텍스트 상자를 렌더링                               |
| quote     | 회색 텍스트 상자를 렌더링                                 |
| custom <sub>1</sub> | 항상 파란색 텍스트 상자를 렌더링                |
| custom <sub>2</sub> | 다른 유형 내에서 사용자 정의 제목을 사용        |

각 열을 크기별로 구분할 필요는 없지만(표의 첫 번째 부분에서 수행한 것처럼) 마크다운 소스 파일에서 확실히 더 읽기 쉽습니다. 표의 마지막 두 항목에서 볼 수 있듯이 파이프 문자 "|"이 있는 열을 자연스러운 구분선이 있는 곳에서 끊는 것만으로도 항목을 함께 묶을 때 혼동될 수 있습니다.

인용 블럭(Block quote)¶

인용구 블록은 문서에 포함시킬 다른 소스에서의 인용문을 나열하는 데 사용되지만, 반드시 그렇게 사용할 필요는 없습니다. 예를 들어 다른 옵션을 나열하는 데 표 대신 인용구 블록을 사용하는 기여자도 있습니다. 마크다운에서 인용구 블록은 다음과 같이 작성합니다:

> **항목** - 해당 항목에 대한 설명

> **다른 항목** - 다른 항목에 대한 다른 설명

라인이 함께 실행되지 않도록 여기에 추가 "간격" 라인이 필요합니다.

페이지가 렌더링되면 다음과 같이 표시됩니다:

항목 - 해당 항목에 대한 설명 다른 항목 - 다른 항목에 대한 설명

인라인 및 블록 수준 코드 블록¶

Our approach to using code blocks is pretty simple. 문장에 코드가 짧을 경우 사용하려면 그대로 사용하면 됩니다(방금 보았던 것처럼), <kbd> 태그를 사용합니다:

'선택한 명령'이 들어간 문장.

텍스트 단락 밖에서 사용되지 않는 모든 명령어(특히 여러 줄로 이루어진 긴 코드)은 완전한 코드 블록으로 정의되어야 합니다. 이때 세 개의 역따옴표 `를 사용합니다:

```bash
sudo dnf install the-kitchen-sink
```

이러한 서식 중 bash 부분은 필수 코드 식별자이지만 구문 강조 효과를 더할 수 있습니다. 물론 Python, PHP, Ruby, HTML, CSS 또는 다른 종류의 코드를 보여주는 경우 "bash"를 사용하는 것은 사용하는 언어에 따라 변경해야 합니다. 또한 코드 블록 내에서 코드 블록을 표시해야 하는 경우 부모 블록에 추가로 하나의 역따옴표 '를 추가하면 됩니다:

````markdown
```bash
sudo dnf install the-kitchen-sink
```
````

그렇게 하면 렌더링을 올바르게 하기 위해 시작과 끝에 각각 다섯 개의 역따옴표가 사용되었습니다.

키보드¶

문서를 가능한 한 명확하게 표현하는 또 다른 방법은 올바른 방식으로 입력해야 하는 키보드 키를 표시하는 것입니다. 이는 <kbd>key</kbd>를 사용하여 수행됩니다. 예를 들어 문서에서 ESC 키를 눌러야 한다고 표시하려면 <kbd>ESC</kbd>를 사용합니다. 여러 개의 키를 눌러야 한다는 경우, <kbd>CTRL</kbd> + <kbd>F4</kbd>와 같이 각 키 사이에 +를 추가합니다. 키가 동시에 눌려야 한다면 "동시에" 또는 "동시에"와 같은 유사한 구문을 지칭하는 구문을 지시사항에 추가합니다. 편집기에서 키보드 지시사항의 예시를 보여드리겠습니다:

작업스테이션 타입 설치(그래픽 인터페이스 포함)은 터미널 1에서 이 인터페이스를 시작합니다. Linux는 멀티 사용자 시스템이므로 여러 사용자가 서로 다른 **물리 터미널(TTY)**이나 **가상 터미널(PTS)**에서 여러 차례 연결할 수 있습니다. 가상 터미널은 그래픽 환경 내에서 사용할 수 있습니다. 사용자는 명령 줄에서 <kbd>Alt</kbd> + <kbd>Fx</kbd>를 눌러서 물리 터미널 간에 전환하거나 <kbd>CTRL</kbd> + <kbd>Alt</kbd> + <kbd>Fx</kbd>를 눌러 가상 터미널 간에 전환할 수 있습니다.

표시될 때 렌더링되는 방법은 다음과 같습니다.

작업스테이션 타입 설치(그래픽 인터페이스 포함)은 터미널 1에서 이 인터페이스를 시작합니다. Linux는 멀티 사용자 시스템이므로 여러 사용자가 서로 다른 물리 터미널(TTY)이나 가상 터미널(PTS)에서 여러 차례 연결할 수 있습니다. 가상 터미널은 그래픽 환경 내에서 사용할 수 있습니다. 사용자는 명령 줄에서 Alt + Fx를 눌러서 물리 터미널 간에 전환하거나 CTRL + Alt + Fx를 눌러 가상 터미널 간에 전환할 수 있습니다.

위 첨자, 아래 첨자 및 특수 기호¶

Superscript와 Subscript 표기법은 일반적인 마크다운 형식은 아니지만 Rocky Linux 문서에서는 이와 같은 목적으로 사용되는 HTML 태그를 지원합니다. Superscript는 태그 사이에 입력된 텍스트를 정상 텍스트보다 약간 위에 배치하고, Subscript는 텍스트를 약간 아래에 배치합니다. Superscript가 이 두 가지 중에서 훨씬 더 많이 사용됩니다. 특수 문자 중 일부는 이미 태그를 추가하지 않고도 Superscript로 표시되지만, 저작권 기호와 같은 문자의 방향을 변경하기 위해 태그를 조합할 수도 있습니다. Superscript를 사용하여 다음과 같은 용도로 사용할 수 있습니다:

순서를 나타냄 (예: 1^st, 2^nd, 3^rd)
저작권 및 상표 기호(예: ^©, ^TM 또는 ™, ®)
참조하는 표기법(예: ¹, ², 그리고 ³)

©와 같은 일부 특수 문자는 는 일반적으로 Superscript로 표시되지 않지만, ™와 같은 다른 문자는 Superscript로 표시됩니다.

아래는 마크다운 코드에서 위의 내용을 어떻게 나타내는지 보여줍니다:

* 순서를 나타냄 (예: 1<sup>st</sup>, 2<sup>nd</sup>, 3<sup>rd</sup>)
* 저작권 및 상표 기호(예: <sup>&copy;</sup>, <sup>TM</sup> 또는 &trade;, &reg;)
* 참조하는 표기법(예: <sup>1</sup>, <sup>2</sup>, 그리고 <sup>3</sup>)

&copy;와 같은 일부 특수 문자는 는 일반적으로 Superscript로 표시되지 않지만, &trade;와 같은 다른 문자는 Superscript로 표시됩니다.

위와 같이 Superscript를 강제로 표시하기 위해 지원되는 HTML 태그 <sup></sup>를 사용할 수 있습니다.

Subscript는 <sub></sub> 태그를 사용하여 입력되며, 앞에서 언급한대로 작성에서는 _{사용빈도가 훨씬 낮습니다}.

참고 표기를 위한 Superscript¶

여러분 중 일부는 문서를 작성할 때 외부 소스를 참조해야 할 필요성을 느낄 수 있습니다. 출처가 하나뿐인 경우 결론에 단일 링크로 포함하고 싶을 수 있지만 여러 개가 있는 경우¹ Superscript 첨자를 사용하여 텍스트에 표시할 수 있습니다² 문서 끝에 나열하십시오. 참조 위치는 "결론" 섹션 뒤에 와야 합니다.

결론에 따라 Superscript 와 일치하도록 번호가 매겨진 목록에 표기법을 표시하거나 링크로 입력할 수 있습니다. 두 가지 예는 다음과 같습니다.

Wordy W. McWords의 "텍스트에서 배수가 사용되는 방법" https://site1.com
Sam B. Supersecret의 "텍스트에 위첨자 사용" https://site2.com

또는

1 Wordy W. McWords의 "텍스트에서 배수가 사용되는 방법"
2 Sam B. Supersecret의 "텍스트에 윗첨자 사용"

편집기에서 모든 것이 다음과 같이 표시됩니다.

1. Wordy W. McWords의 "텍스트에서 배수가 사용되는 방법"
[https://site1.com](https://site1.com)
2. Sam B. Supersecret의 "텍스트에 윗첨자 사용" [https://site2.com](https://site2.com)

또는

[1](https://site1.com) Wordy W. McWords의 "텍스트에서 배수가 사용되는 방법"
[2](https://site2.com) Sam B. Supersecret의 "텍스트에 윗첨자 사용"

다양한 서식 유형 그룹화¶

Rocky Documentation은 다른 요소를 또 다른 요소 안에 조합할 때 일부 우아한 서식 옵션을 제공합니다. 예를 들어 주의 사항과 번호 매긴 목록을 함께 묶을 때:

참고사항

여러 가지를 함께 그룹화하면 약간 혼란스러워질 수 있습니다. 예를 들면:

주의 사항 안에 옵션의 번호 매긴 목록을 추가할 때
또는 여러 코드 블록이 포함된 번호 매긴 목록을 추가할 때:
```
dnf install some-great-package
```
이것은 여러 단락으로 이루어진 번호 매긴 목록 내부에 있습니다.

또는 번호 매긴 목록 안에 추가적인 주의 사항이 있는 경우:

이 항목은 매우 중요합니다.

여기에 목록 항목에 키보드 명령을 추가합니다:

특별한 이유 없이 ESC를 누르십시오.
하지만 이 항목은 매우 중요하며 여러 단락이 있습니다.

그리고 중간에 다음과 같은 주의사항이 있습니다.

주의

여러 가지 서식 유형을 포함하는 것은 약간 혼란스러울 수 있습니다!

이러한 항목을 구분하기 위해 중요한 것은 이러한 항목들을 분리하고 들여쓰기하는 마법의 네 개 (4) 공백을 기억하는 것입니다. 이렇게 하면 원하는대로 논리적으로 표시됩니다. 때로는 이것이 정말 중요합니다.

표 또는 인용구 블록을 다른 요소 안에 넣을 수도 있습니다(사실상 모든 서식 항목 유형). 다음은 번호 매긴 목록, 주의 사항, 표 및 일부 인용구 요소가 모두 함께 묶인 예시입니다:

여러 요소로 작업할 때 문서에서 진행되는 모든 작업을 따라가는 것은 실제 작업이 될 수 있습니다.

만약 혼란스러워진다면 다음을 고려해 보십시오:

중요: 머리가 아픈 것 같아요!

여러 요소를 조합할 때 머리가 약간 아플 수 있습니다. 시작하기 전에 약간의 카페인을 섭취하는 것을 고려하십시오!

유형	하루 카페인 섭취량
차	약간 시간이 걸릴 수 있습니다
커피	요리하는 미각을 위한 것
레드불	맛이 엄청 심하긴 하지만 기운은 빠르게 생깁니다!
마운틴 듀	과대 광고

설탕 카페인이 맘에 들지 않는다면

고생 다른 모든 것이 실패한다면, 더 집중하세요

더 많은 예제가 있지만 위의 예시는 모든 요소를 내포할 수 있다는 것을 보여줍니다. 마법의 네 개 (4) 공백을 기억하세요.

이 예제는 편집기에서 다음과 같이 표시됩니다.

이러한 항목을 구분하기 위해 중요한 것은 이러한 항목들을 분리하고 들여쓰기하는 마법의 네 개 (4) 공백을 기억하는 것입니다. 이렇게 하면 원하는대로 논리적으로 표시됩니다. 때로는 이것이 정말 중요합니다.

표 또는 인용구 블록을 다른 요소 안에 넣을 수도 있습니다(사실상 모든 서식 항목 유형). 다음은 번호 매긴 목록, 주의 사항, 표 및 일부 인용구 요소가 모두 함께 묶인 예시입니다:


1. 여러 요소로 작업할 때 문서에서 진행되는 모든 작업을 따라가는 것은 실제 작업이 될 수 있습니다.

2. 만약 혼란스러워진다면 다음을 고려해 보십시오:

    !!! 경고 "중요: 머리가 아픈 것 같아요!"

        여러 요소를 조합할 때 머리가 약간 아플 수 있습니다. 시작하기 전에 약간의 카페인을 섭취하는 것을 고려하십시오!

        | type            |   caffeine daily allowance       |
        |-----------------|----------------------------------|
        | tea             | it will get you there eventually |
        | coffee          | for discerning taste buds        |
        | red bull        | tastes terrible - but it will keep you going! |
        | 마운틴 듀   | 과대 광고                     |

        > **설탕** 카페인이 맘에 들지 않는다면

        > **고생** 다른 모든 것이 실패한다면, 더 집중하세요


3. 더 많은 예제가 있지만 위의 예시는 모든 요소를 내포할 수 있다는 것을 보여줍니다. 마법의 네 개 (4) 공백을 기억하세요.

마지막 최총 항목 - 코멘트¶

가끔씩 렌더링될 때 표시되지 않는 마크다운에 주석을 추가하고 싶을 수 있습니다. 이를 위해 여러 가지 이유가 있을 수 있습니다. 예를 들어, 나중에 추가될 항목에 대한 자리 표시자를 추가하려면 주석을 사용할 수 있습니다.

마크다운에 주석을 추가하는 가장 좋은 방법은 "//" 사이에 두 개의 대괄호 "[]"를 사용한 다음 콜론과 내용을 추가하는 것입니다. 이렇게 보일 것입니다:

[//]: 이것은 나중에 대체될 주석입니다

주석은 주석 전후로 공백 줄을 가질 필요가 있습니다.

더 읽어보기¶

Rocky Linux 문서 기여 방법
주의 사항에 대해 자세히 알아보기
마크다운 빠른 참조
Markdown에 대한 더 빠른 참조

결론¶

제목, 주의 사항, 표, 번호 매긴 목록 및 인용구 블록과 같은 문서 서식은 문서에 명확성을 추가할 수 있습니다. 주의 사항을 사용할 때 올바른 유형을 선택하는 데 주의하십시오. 이는 특정 주의 사항의 중요성을 시각적으로 확인하기 쉽게 만들어 줍니다.

고급 서식 옵션을 사용할 필요는 없습니다. 특수 요소의 과도한 사용은 필요하지 않은 경우에 혼란을 초래할 수 있습니다. 이러한 서식 항목을 절제하고 잘 사용하는 방법을 익히는 것은 문서에서 의견을 전달하는 데 매우 유용할 수 있습니다.

마지막으로, 서식을 쉽게 만들기 위해 마크다운 편집기의 TAB 값이 네 개 (4) 공백으로 설정하는 것을 고려해 보세요.

Author: Steven Spencer

Contributors: tianci li, Ezequiel Bruni, Krista Burdine