Admonition

Admonitions 요약

Admonitions(주석)는 문서의 흐름을 방해하지 않으면서 사이드 콘텐츠를 포함하기 위한 좋은 방법입니다. MkDocs Material 테마에서는 다양한 유형의 주석을 제공하며, 내부에 임의의 콘텐츠를 포함하고 중첩시킬 수 있습니다.

설정 방법

mkdocs.yml 파일에 다음 설정을 추가하여 주석을 활성화하고, 접기 기능과 중첩 콘텐츠를 허용합니다:

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

주석 아이콘 설정

각 주석 유형에는 고유한 아이콘이 있으며, 이를 테마에 번들된 아이콘으로 변경하거나 사용자 지정 아이콘으로 설정할 수 있습니다:

theme:
  icon:
    admonition:
      <type>: <icon>

사용 방법

주석은 간단한 구문을 따릅니다: !!! 뒤에 주석의 유형을 지정하고, 다음 줄에 4칸 들여쓰기된 콘텐츠를 입력합니다.

!!! note
    여기에 주석 내용을 작성합니다.

Note

여기에 주석 내용을 작성합니다.

제목 변경

기본적으로 주석의 제목은 유형에 따라 자동으로 생성되지만, 제목을 변경하고 싶다면 다음과 같이 사용할 수 있습니다:

!!! note "사용자 지정 제목"
    여기에 주석 내용을 작성합니다.

사용자 지정 제목

여기에 주석 내용을 작성합니다.

제목 제거

주석의 제목과 아이콘을 모두 제거하려면 다음과 같이 빈 문자열을 추가합니다:

!!! note ""
    여기에 주석 내용을 작성합니다.

여기에 주석 내용을 작성합니다.

접기 가능한 주석

???로 주석을 시작하면 접기 가능한 블록으로 렌더링됩니다:

??? note
    접기 가능한 주석 내용

Note

접기 가능한 주석 내용

???+를 사용하면 처음부터 펼쳐진 상태로 렌더링됩니다:

???+ note
    펼쳐진 주석 내용

Note

펼쳐진 주석 내용

지원되는 주석 유형

다음은 Material for MkDocs에서 제공하는 주석 유형의 목록입니다:

note

노트

이 메시지는 기본 노트 유형입니다. 중요한 정보가 있을 때 사용합니다.

abstract

요약

이 섹션은 내용을 요약하거나 설명할 때 유용합니다.

info

정보

이 메시지는 정보 전달에 적합한 주석입니다.

tip

팁

팁이나 유용한 힌트를 제공할 때 사용합니다.

success

성공

성공적인 결과나 완료된 작업을 강조할 때 사용합니다.

question

질문

자주 묻는 질문이나 사용자 질문을 표시할 때 유용합니다.

warning

경고

주의가 필요할 때 이 경고 메시지를 사용합니다.

failure

실패

작업 실패나 에러에 대한 정보를 제공할 때 사용합니다.

danger

위험

매우 중요한 경고나 위험한 상황을 알릴 때 사용합니다.

bug

버그

소프트웨어 버그나 문제를 알릴 때 사용합니다.

example

예시

사용 예시나 코드 샘플을 제공할 때 유용합니다.

quote

인용

중요한 인용문이나 참조를 강조할 때 사용합니다.

참고

inline 옵션을 사용하려면 주석을 문서의 내용 앞에 선언해야 합니다.
작은 화면(예: 모바일)에서는 인라인 주석이 전체 너비로 확장될 수 있습니다.

이 내용을 바탕으로 필요한 주석을 쉽게 구성할 수 있습니다.