InfoGrab DocsInfoGrab Docs

숏코드와 콘텐츠 블록

요약

숏코드는 Markdown 콘텐츠에 포함해 제공 형태 정보나 탭 같은 비표준 요소를 페이지에 표시하는 템플릿 코드 조각입니다. GitLab 문서는 다음 숏코드를 사용합니다. 가이드 숏코드를 사용해 스타일이 적용된 순서 있는 단계 목록을 만듭니다.

숏코드#

숏코드는 Markdown 콘텐츠에 포함해 제공 형태 정보나 탭 같은 비표준 요소를 페이지에 표시하는 템플릿 코드 조각입니다.

GitLab 문서는 다음 숏코드를 사용합니다.

가이드#

가이드 숏코드를 사용해 스타일이 적용된 순서 있는 단계 목록을 만듭니다. 가이드 안에 알림 같은 다른 숏코드를 중첩할 수 있습니다. 다만 렌더링된 스타일 때문에 내용을 훑어보기 어려워질 수 있으므로 드물게 사용합니다.

가이드 안에 가이드를 사용하지 않습니다.

가이드를 만들려면 다음 예시를 따릅니다.



1. Guide item with text.

   An item with text only.
1. Guide item with alert.

   This is an item with an alert.

   > [!note]
   > This is a note.


이 코드는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

  1. Guide item with text.

    An item with text only.

  2. Guide item with alert.

    An item with an alert.

    [!note] This is a note.

가이드 스타일은 GitLab 문서 사이트(https://docs.gitlab.com)에서만 렌더링됩니다. GitLab 제품 도움말에서는 가이드가 일반 순서 있는 항목 목록으로 표시됩니다.

가이드는 튜토리얼에만 사용합니다. 대부분의 작업에는 순서 있는 목록을 사용합니다.

알림 상자#

알림 상자를 사용해 정보에 주의를 환기합니다. 드물게 사용하며, 알림 상자 바로 뒤에 다른 알림 상자를 두지 않습니다.

알림 상자는 Markdown 알림으로 생성합니다.

<div class="admonition note"><div class="admonition-title">Note</div>

The text inside the alert box goes here.

</div>```

유효한 알림 유형은 `flag`, `note`, `warning`, `disclaimer`입니다. 알림 유형은 대소문자를 구분하지 않습니다.

### Flag

이 알림 유형은 기능의 제공 여부를 설명할 때 사용합니다. `flag` 알림의 서식은
[기능 플래그 뒤에 배포된 기능 문서화](../feature_flags.md)를 참고합니다.

### Note

노트는 드물게 사용합니다. 노트가 너무 많으면 항목을 훑어보기 어려워질 수 있습니다.

노트를 추가하는 대신 다음을 고려합니다.

- 문장을 문단의 일부로 다시 작성합니다.
- 정보를 별도의 문단에 둡니다.
- 내용을 새 항목 제목 아래에 둡니다.

노트를 꼭 사용해야 한다면 다음 형식을 사용합니다.

```plaintext
<div class="admonition note"><div class="admonition-title">Note</div>

This is something to note.

</div>```

GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

<div class="admonition note"><div class="admonition-title">Note</div>

This is something to note.

</div>

### Warning

더 이상 사용되지 않는 기능을 표시하거나, 데이터 손실 가능성이 있는 절차를 경고할 때
경고를 사용합니다.

```plaintext
<div class="admonition warning"><div class="admonition-title">Warning</div>

This is something to be warned about.

</div>```

GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

<div class="admonition warning"><div class="admonition-title">Warning</div>

This is something to be warned about.

</div>

### Disclaimer

아직 제공하지 않은 기능에 대해 써야 한다면, 해당되는 내용 근처에 미래 예측 진술에 관한 면책 조항을 추가합니다.

면책 조항 알림은 [템플릿](https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/themes/gitlab-docs/layouts/shortcodes/alert.html)으로 채워지므로
다른 텍스트를 포함하지 않아야 합니다.

면책 조항은 다음과 같이 추가합니다.

```plaintext
<div class="admonition warning"><div class="admonition-title">Disclaimer</div>

이 페이지에는 개발 중인 제품, 기능에 대한 정보가 포함되어 있습니다. 이 정보는 참고 목적으로만 제공되며, 구매 또는 계획 시 이 정보에 의존하지 마십시오.

</div>

GitLab 문서 사이트에서 면책 조항 텍스트와 함께 렌더링됩니다.

Disclaimer

이 페이지에는 개발 중인 제품, 기능에 대한 정보가 포함되어 있습니다. 이 정보는 참고 목적으로만 제공되며, 구매 또는 계획 시 이 정보에 의존하지 마십시오.

페이지의 모든 내용이 아직 제공되지 않는 경우, 미래 예측 진술에 관한 면책 조항을 페이지 맨 위에 한 번 사용합니다.

항목의 내용이 아직 준비되지 않은 경우 해당 항목에서 면책 조항을 사용합니다.

자세한 내용은 향후 버전의 기능 예고를 참고합니다.

인용 블록#

제품 문서에서는 인용 블록 사용을 피합니다. 인용 블록은 텍스트를 훑어보기 어렵게 만들 수 있습니다. 인용 블록 대신 다음을 고려합니다.

GitLab Flavored Markdown (GLFM) 페이지는 일반 텍스트와 렌더링된 예시를 구분하려고 인용 블록을 사용하는 드문 경우입니다. 그러나 대부분의 경우 인용 블록을 피해야 합니다.

탭#

문서 사이트에서는 텍스트를 탭으로 표시하도록 서식을 지정할 수 있습니다.

Warning

탭 안에 버전 히스토리 불릿, 항목 제목, HTML, 탭을 넣지 않습니다. 문단, 목록, 알림 상자, 코드 블록만 사용합니다. 그 밖의 스타일은 제대로 렌더링되지 않을 수 있습니다. 확신이 서지 않으면 단순하게 유지합니다.

탭 집합을 만들려면 다음 예시를 따릅니다.





Here's some content in tab one.





Here's some other content in tab two.




이 코드는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

Here's some content in tab one.

Here's some other content in tab two.

탭 제목은 간결하고 일관되게 작성합니다. 서로 병렬 구조가 되도록 하고, 각각 대문자로 시작합니다. 예를 들면 다음과 같습니다.

  • Linux package (Omnibus), Helm chart (Kubernetes) (구성 편집을 문서화할 때는 구성 편집 가이드를 따릅니다)
  • 15.1 and earlier, 15.2 and later

탭으로 연결되는 깨진 링크에 대한 자동 테스트를 구현하기 전까지는 단일 탭으로 직접 링크하지 않습니다. 자세한 내용은 이슈 225를 참고합니다.

탭에 대한 자세한 내용은 Pajamas를 참고합니다.

접을 수 있는 패널#

접을 수 있는 패널은 기본적으로 닫혀 있으며 제목이 필요합니다. 렌더링된 문서에서 패널 안의 내용을 보려면 패널을 펼쳐야 합니다.



This content appears inside the collapsible panel.


접을 수 있는 패널은 제공 형태 세부 정보 섹션에서 지원되는 LLM, 편집기, 자체 호스팅 모델 제공 여부에 관한 정보에 대해서만 GitLab Duo 페이지에서 사용합니다.

다른 콘텐츠에는 접을 수 있는 패널을 사용하지 않습니다.

카드#

카드를 사용해 하위 페이지로 연결되는 링크가 있는 랜딩 페이지를 만듭니다.

카드 집합을 만들려면 다음 예시를 따릅니다.



- [The first page](first_page.md)
- [Another page](another/page.md)
- [One more page](one_more.md)


또한 카드는 선택 사항인 설명과 함께 외부 URL을 지원합니다. 다음 구문을 사용합니다.



- [External page title](https://example.com "Optional Description")


카드는 GitLab 문서 사이트(https://docs.gitlab.com)에서만 렌더링됩니다. GitLab 제품 도움말에서는 카드 집합이 순서 없는 링크 목록으로 표시됩니다.

카드 설명은 Markdown 페이지 헤더의 description 메타데이터로 채워집니다.

카드가 페이지의 유일한 콘텐츠인 최상위 페이지에서 카드를 사용합니다.

유지 관리 버전#

유지 관리 버전 숏코드를 사용해 유지 관리 정책에 명시된 현재 유지 관리 중인 GitLab 버전의 순서 없는 목록을 만듭니다.


유지 관리 버전은 GitLab 문서 사이트(https://docs.gitlab.com)의 사전 릴리스 버전에서만 렌더링됩니다. 그 밖의 모든 경우와 /help에서는 문서 사이트로 연결되는 링크가 대신 표시됩니다.

용어집 툴팁#

용어집 툴팁 숏코드를 사용해 마우스를 올리면 툴팁으로 나타나는 짧은 정의를 제공합니다. 예를 들면 다음과 같습니다.

To do this thing, use .

사용자가 위에 마우스를 올리면 툴팁이 표시됩니다.

용어집 페이지가 툴팁에 구성되어 있고 사용자가 앵커 텍스트를 선택하면 관련 용어집 페이지가 열립니다.

사용 지침#

정의가 간결한 한 문장이면 용어집 툴팁을 사용하고, 가능하면 60자 이내로 작성합니다. 더 긴 정의에는 용어집 페이지를 사용합니다.

한 페이지에서 툴팁을 5~10개 넘게 사용하지 않습니다. 툴팁마다 독자의 읽기 속도가 느려집니다. 정의로 사용자에게 과부하를 주지 않도록 주의합니다.

다음 경우에 용어집 툴팁을 사용합니다.

  • 페이지에서 GitLab 고유 용어가 처음 나올 때.
  • artifact나 analyzer처럼 독자가 모를 수 있는 용어.

다음 경우에는 용어집 툴팁을 사용하지 않습니다.

  • 리포지터리, 브랜치, 커밋 같은 일반 용어.
  • 용어가 나올 때마다 매번.
  • 약어를 대체하는 용도. 처음 사용할 때 약어를 풀어 쓸 수 있고 업계 표준이면 용어집 툴팁을 사용하지 않습니다.

용어집 용어 만들기#

docs-gitlab-com 리포지터리의 glossary.yaml 파일에 용어집 정의를 추가합니다. 각 정의는 짧아야 하며 링크를 포함하지 않아야 합니다.

용어집 용어는 terms 블록에서 다음 필드로 정의합니다.

term_id

: 용어집 용어의 고유 ID. 용어집 섹션에 연결하려면 term_id가 용어집 페이지에서 해당 용어의 앵커와 일치해야 합니다.

display_name

: 문서에 표시되는 텍스트. display_name 필드는 대소문자를 구분하지 않습니다. 예를 들어 숏코드의 text 매개변수가 "attack surface"이면 glossary.yaml 파일의 "Attack Surface" 용어와 일치합니다.

glossary

: 선택 사항. 용어의 용어집 정의로 연결되는 링크. 포함하면 term_id가 glossary_url 끝에 덧붙여집니다. 예: /user/application_security/terminology#attack-surface.

short_description

: 사용자가 툴팁 위에 마우스를 올릴 때 나타나는 텍스트.

glossary.yaml 파일의 용어집 용어 정의 예시:

terms:
  - term_id: attack-surface
    display_name: Attack Surface
    glossary: *security_glossary
    short_description: The different places in an application that are vulnerable to attack

용어집은 glossary.yaml 파일의 맨 위에 정의합니다.

첫 번째 줄은 고유 ID 두 개로 구성됩니다.

  1. 용어집의 짧은 이름.
  2. 용어집의 더 긴 식별자. 이 용어집에 연결되는 용어집 용어는 glossary 필드가 이 값과 일치해야 합니다.

glossary_url

: 용어가 정의된 용어집 페이지의 루트 URL.

glossary.yaml 파일의 용어집 정의 예시:

# Glossary files
security: &security_glossary
  glossary_url: "/user/application_security/terminology"

이 예시를 결합하면 다음과 같이 동작합니다.

  • 문서에서 "Attack Surface"라는 구문이 링크로 표시됩니다.
  • 사용자가 링크 위에 마우스를 올리면 short_description 필드의 내용이 툴팁에 표시됩니다.
  • 사용자가 링크를 선택하면 용어집 페이지가 앵커 attack-surface 위치에서 열립니다.

숏코드와 콘텐츠 블록

GitLab v19.6
원문 보기

요약

숏코드는 Markdown 콘텐츠에 포함해 제공 형태 정보나 탭 같은 비표준 요소를 페이지에 표시하는 템플릿 코드 조각입니다. GitLab 문서는 다음 숏코드를 사용합니다. 가이드 숏코드를 사용해 스타일이 적용된 순서 있는 단계 목록을 만듭니다.

숏코드#

숏코드는 Markdown 콘텐츠에 포함해 제공 형태 정보나 탭 같은 비표준 요소를 페이지에 표시하는 템플릿 코드 조각입니다.

GitLab 문서는 다음 숏코드를 사용합니다.

가이드#

가이드 숏코드를 사용해 스타일이 적용된 순서 있는 단계 목록을 만듭니다. 가이드 안에 알림 같은 다른 숏코드를 중첩할 수 있습니다. 다만 렌더링된 스타일 때문에 내용을 훑어보기 어려워질 수 있으므로 드물게 사용합니다.

가이드 안에 가이드를 사용하지 않습니다.

가이드를 만들려면 다음 예시를 따릅니다.



1. Guide item with text.

   An item with text only.
1. Guide item with alert.

   This is an item with an alert.

   > [!note]
   > This is a note.


이 코드는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

  1. Guide item with text.

    An item with text only.

  2. Guide item with alert.

    An item with an alert.

    [!note] This is a note.

가이드 스타일은 GitLab 문서 사이트(https://docs.gitlab.com)에서만 렌더링됩니다. GitLab 제품 도움말에서는 가이드가 일반 순서 있는 항목 목록으로 표시됩니다.

가이드는 튜토리얼에만 사용합니다. 대부분의 작업에는 순서 있는 목록을 사용합니다.

알림 상자#

알림 상자를 사용해 정보에 주의를 환기합니다. 드물게 사용하며, 알림 상자 바로 뒤에 다른 알림 상자를 두지 않습니다.

알림 상자는 Markdown 알림으로 생성합니다.

<div class="admonition note"><div class="admonition-title">Note</div>

The text inside the alert box goes here.

</div>```

유효한 알림 유형은 `flag`, `note`, `warning`, `disclaimer`입니다. 알림 유형은 대소문자를 구분하지 않습니다.

### Flag

이 알림 유형은 기능의 제공 여부를 설명할 때 사용합니다. `flag` 알림의 서식은
[기능 플래그 뒤에 배포된 기능 문서화](../feature_flags.md)를 참고합니다.

### Note

노트는 드물게 사용합니다. 노트가 너무 많으면 항목을 훑어보기 어려워질 수 있습니다.

노트를 추가하는 대신 다음을 고려합니다.

- 문장을 문단의 일부로 다시 작성합니다.
- 정보를 별도의 문단에 둡니다.
- 내용을 새 항목 제목 아래에 둡니다.

노트를 꼭 사용해야 한다면 다음 형식을 사용합니다.

```plaintext
<div class="admonition note"><div class="admonition-title">Note</div>

This is something to note.

</div>```

GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

<div class="admonition note"><div class="admonition-title">Note</div>

This is something to note.

</div>

### Warning

더 이상 사용되지 않는 기능을 표시하거나, 데이터 손실 가능성이 있는 절차를 경고할 때
경고를 사용합니다.

```plaintext
<div class="admonition warning"><div class="admonition-title">Warning</div>

This is something to be warned about.

</div>```

GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

<div class="admonition warning"><div class="admonition-title">Warning</div>

This is something to be warned about.

</div>

### Disclaimer

아직 제공하지 않은 기능에 대해 써야 한다면, 해당되는 내용 근처에 미래 예측 진술에 관한 면책 조항을 추가합니다.

면책 조항 알림은 [템플릿](https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/blob/main/themes/gitlab-docs/layouts/shortcodes/alert.html)으로 채워지므로
다른 텍스트를 포함하지 않아야 합니다.

면책 조항은 다음과 같이 추가합니다.

```plaintext
<div class="admonition warning"><div class="admonition-title">Disclaimer</div>

이 페이지에는 개발 중인 제품, 기능에 대한 정보가 포함되어 있습니다. 이 정보는 참고 목적으로만 제공되며, 구매 또는 계획 시 이 정보에 의존하지 마십시오.

</div>

GitLab 문서 사이트에서 면책 조항 텍스트와 함께 렌더링됩니다.

Disclaimer

이 페이지에는 개발 중인 제품, 기능에 대한 정보가 포함되어 있습니다. 이 정보는 참고 목적으로만 제공되며, 구매 또는 계획 시 이 정보에 의존하지 마십시오.

페이지의 모든 내용이 아직 제공되지 않는 경우, 미래 예측 진술에 관한 면책 조항을 페이지 맨 위에 한 번 사용합니다.

항목의 내용이 아직 준비되지 않은 경우 해당 항목에서 면책 조항을 사용합니다.

자세한 내용은 향후 버전의 기능 예고를 참고합니다.

인용 블록#

제품 문서에서는 인용 블록 사용을 피합니다. 인용 블록은 텍스트를 훑어보기 어렵게 만들 수 있습니다. 인용 블록 대신 다음을 고려합니다.

GitLab Flavored Markdown (GLFM) 페이지는 일반 텍스트와 렌더링된 예시를 구분하려고 인용 블록을 사용하는 드문 경우입니다. 그러나 대부분의 경우 인용 블록을 피해야 합니다.

탭#

문서 사이트에서는 텍스트를 탭으로 표시하도록 서식을 지정할 수 있습니다.

Warning

탭 안에 버전 히스토리 불릿, 항목 제목, HTML, 탭을 넣지 않습니다. 문단, 목록, 알림 상자, 코드 블록만 사용합니다. 그 밖의 스타일은 제대로 렌더링되지 않을 수 있습니다. 확신이 서지 않으면 단순하게 유지합니다.

탭 집합을 만들려면 다음 예시를 따릅니다.





Here's some content in tab one.





Here's some other content in tab two.




이 코드는 GitLab 문서 사이트에서 다음과 같이 렌더링됩니다.

Here's some content in tab one.

Here's some other content in tab two.

탭 제목은 간결하고 일관되게 작성합니다. 서로 병렬 구조가 되도록 하고, 각각 대문자로 시작합니다. 예를 들면 다음과 같습니다.

  • Linux package (Omnibus), Helm chart (Kubernetes) (구성 편집을 문서화할 때는 구성 편집 가이드를 따릅니다)
  • 15.1 and earlier, 15.2 and later

탭으로 연결되는 깨진 링크에 대한 자동 테스트를 구현하기 전까지는 단일 탭으로 직접 링크하지 않습니다. 자세한 내용은 이슈 225를 참고합니다.

탭에 대한 자세한 내용은 Pajamas를 참고합니다.

접을 수 있는 패널#

접을 수 있는 패널은 기본적으로 닫혀 있으며 제목이 필요합니다. 렌더링된 문서에서 패널 안의 내용을 보려면 패널을 펼쳐야 합니다.



This content appears inside the collapsible panel.


접을 수 있는 패널은 제공 형태 세부 정보 섹션에서 지원되는 LLM, 편집기, 자체 호스팅 모델 제공 여부에 관한 정보에 대해서만 GitLab Duo 페이지에서 사용합니다.

다른 콘텐츠에는 접을 수 있는 패널을 사용하지 않습니다.

카드#

카드를 사용해 하위 페이지로 연결되는 링크가 있는 랜딩 페이지를 만듭니다.

카드 집합을 만들려면 다음 예시를 따릅니다.



- [The first page](first_page.md)
- [Another page](another/page.md)
- [One more page](one_more.md)


또한 카드는 선택 사항인 설명과 함께 외부 URL을 지원합니다. 다음 구문을 사용합니다.



- [External page title](https://example.com "Optional Description")


카드는 GitLab 문서 사이트(https://docs.gitlab.com)에서만 렌더링됩니다. GitLab 제품 도움말에서는 카드 집합이 순서 없는 링크 목록으로 표시됩니다.

카드 설명은 Markdown 페이지 헤더의 description 메타데이터로 채워집니다.

카드가 페이지의 유일한 콘텐츠인 최상위 페이지에서 카드를 사용합니다.

유지 관리 버전#

유지 관리 버전 숏코드를 사용해 유지 관리 정책에 명시된 현재 유지 관리 중인 GitLab 버전의 순서 없는 목록을 만듭니다.


유지 관리 버전은 GitLab 문서 사이트(https://docs.gitlab.com)의 사전 릴리스 버전에서만 렌더링됩니다. 그 밖의 모든 경우와 /help에서는 문서 사이트로 연결되는 링크가 대신 표시됩니다.

용어집 툴팁#

용어집 툴팁 숏코드를 사용해 마우스를 올리면 툴팁으로 나타나는 짧은 정의를 제공합니다. 예를 들면 다음과 같습니다.

To do this thing, use .

사용자가 위에 마우스를 올리면 툴팁이 표시됩니다.

용어집 페이지가 툴팁에 구성되어 있고 사용자가 앵커 텍스트를 선택하면 관련 용어집 페이지가 열립니다.

사용 지침#

정의가 간결한 한 문장이면 용어집 툴팁을 사용하고, 가능하면 60자 이내로 작성합니다. 더 긴 정의에는 용어집 페이지를 사용합니다.

한 페이지에서 툴팁을 5~10개 넘게 사용하지 않습니다. 툴팁마다 독자의 읽기 속도가 느려집니다. 정의로 사용자에게 과부하를 주지 않도록 주의합니다.

다음 경우에 용어집 툴팁을 사용합니다.

  • 페이지에서 GitLab 고유 용어가 처음 나올 때.
  • artifact나 analyzer처럼 독자가 모를 수 있는 용어.

다음 경우에는 용어집 툴팁을 사용하지 않습니다.

  • 리포지터리, 브랜치, 커밋 같은 일반 용어.
  • 용어가 나올 때마다 매번.
  • 약어를 대체하는 용도. 처음 사용할 때 약어를 풀어 쓸 수 있고 업계 표준이면 용어집 툴팁을 사용하지 않습니다.

용어집 용어 만들기#

docs-gitlab-com 리포지터리의 glossary.yaml 파일에 용어집 정의를 추가합니다. 각 정의는 짧아야 하며 링크를 포함하지 않아야 합니다.

용어집 용어는 terms 블록에서 다음 필드로 정의합니다.

term_id

: 용어집 용어의 고유 ID. 용어집 섹션에 연결하려면 term_id가 용어집 페이지에서 해당 용어의 앵커와 일치해야 합니다.

display_name

: 문서에 표시되는 텍스트. display_name 필드는 대소문자를 구분하지 않습니다. 예를 들어 숏코드의 text 매개변수가 "attack surface"이면 glossary.yaml 파일의 "Attack Surface" 용어와 일치합니다.

glossary

: 선택 사항. 용어의 용어집 정의로 연결되는 링크. 포함하면 term_id가 glossary_url 끝에 덧붙여집니다. 예: /user/application_security/terminology#attack-surface.

short_description

: 사용자가 툴팁 위에 마우스를 올릴 때 나타나는 텍스트.

glossary.yaml 파일의 용어집 용어 정의 예시:

terms:
  - term_id: attack-surface
    display_name: Attack Surface
    glossary: *security_glossary
    short_description: The different places in an application that are vulnerable to attack

용어집은 glossary.yaml 파일의 맨 위에 정의합니다.

첫 번째 줄은 고유 ID 두 개로 구성됩니다.

  1. 용어집의 짧은 이름.
  2. 용어집의 더 긴 식별자. 이 용어집에 연결되는 용어집 용어는 glossary 필드가 이 값과 일치해야 합니다.

glossary_url

: 용어가 정의된 용어집 페이지의 루트 URL.

glossary.yaml 파일의 용어집 정의 예시:

# Glossary files
security: &security_glossary
  glossary_url: "/user/application_security/terminology"

이 예시를 결합하면 다음과 같이 동작합니다.

  • 문서에서 "Attack Surface"라는 구문이 링크로 표시됩니다.
  • 사용자가 링크 위에 마우스를 올리면 short_description 필드의 내용이 툴팁에 표시됩니다.
  • 사용자가 링크를 선택하면 용어집 페이지가 앵커 attack-surface 위치에서 열립니다.