콘텐츠로 이동

베이스 파일 만들기

English | Français | 한국어 | 日本語

이 페이지에서는 Base 파일을 작성하는 규칙에 대해 상세히 설명합니다.

요약

MMG는 markdown 파일이나 jupyter notebook의 markdown 셀을 읽어 내용을 분류하는데, 이를 위해 다음과 같은 특정한 markdown 주석을 사용합니다.

  • 헤더
    • <!-- multilingual suffix: 키워드1, 키워드2, 키워드3 -->: 앞으로 어떤 키워드를 사용할 것인지 선언합니다.
    • <!-- no suffix: 키워드 -->: 지정한 키워드에 대해, 파일을 생성할 때 접미사를 붙이지 않습니다.
  • 매크로
    • <!-- [[ multilingual toc: level=2~3 ]] -->: 해당 위치에 각 키워드별 목차를 자동으로 생성합니다.
  • 본문
    • <!-- [키워드] -->: 해당 섹션이 어떤 키워드에 속하는지 선언합니다.
    • <!-- [common] -->: 모든 언어에 공통적으로 들어갈 내용을 선언합니다.
    • <!-- [ignore] -->: 해당 섹션을 MMG가 무시하도록 합니다.

안내

MMG 문서에서는 '키워드'와 '태그'를 구분하지 않고 혼용하여 사용합니다. 소스코드에는 suffix 또는 lang_tags라는 변수명으로도 쓰입니다. 모두 같은 의미입니다.

헤더

안내

v2.0.0부터 헤더는 문서 어디에서 선언해도 상관없습니다. 하지만, v1.x.x에서는 헤더는 반드시 본문이 시작하기 전에 선언되어야 합니다.

사용할 키워드 선언

사용할 키워드를 선언합니다. 키워드는 쉼표로 구분합니다. 키워드에는 IETF 언어 태그를 사용할 수 있습니다.

<!-- multilingual suffix: en, kr, fr, es, jp, cn -->

생성할 파일에 접미사 붙이지 않기 (Optional)

지정한 키워드에 대해, 파일을 생성할 때 접미사를 붙이지 않습니다. 예를 들어, no suffix: en를 설정하면 파일이름.en.md가 아니라 파일이름.md가 생성됩니다. GitHub에서 메인 README는 접미사가 붙으면 인식이 안되기 때문에, 메인 README가 될 파일에는 no suffix를 설정하는 것이 좋습니다.

<!-- no suffix: en -->

매크로

목차 매크로

Base 파일에는 여러 키워드의 내용이 섞여 있어서, markdown 목차를 자동으로 생성해주는 기존의 방법들은 사용할 수 없습니다. 그래서 MMG는 목차를 자동으로 생성해주는 매크로를 제공합니다.

<!-- [[ multilingual toc: level=2~3 ]] -->

Level 옵션

목차에 표시할 제목의 수준은 level을 통해 지정할 수 있습니다. 하나의 문서에 목차 매크로는 여러번 쓸 수 있고, 매번 다른 level 옵션을 줄 수도 있습니다.

주의 사항

  • 이 level 옵션은 필수입니다. 만약 level을 생략하면 MMG는 이 매크로를 일반 주석으로 인식합니다.
  • 목차 매크로는 암묵적으로 <!-- [common] -->에 속한 것으로 간주됩니다. 그래서 목차 매크로를 사용하면 자동으로 현재 키워드가 common으로 변경됩니다.

level을 표기하는 방법에는 네 가지가 있습니다.

  • level=2: 2수준의 제목만 목차로 만듭니다.
  • level=2~: 2 ~ 9수준의 제목을 목차로 만듭니다.
  • level=~4: 1 ~ 4수준의 제목을 목차로 만듭니다.
  • level=2~4: 2 ~ 4수준의 제목을 목차로 만듭니다.

이모지 제거 옵션

간혹, 제목에는 이모티콘을 넣으면서 목차에서는 이모티콘을 지우고 싶을 때가 있습니다. 만약 당신이 이와 같은 상황이라면, 아래와 같이 no-emoji 옵션을 적용하세요.

<!-- [[ multilingual toc: level=2~3 no-emoji ]] -->

no-emoji가 적용되면, 이모티콘을 제외한 제목만 목차에 표시됩니다.

**Table of Contents**

1. [Heading 1](#heading-1-)
2. [Heading 2](#heading-2-)

# Heading 1 💎
# Heading 2 ❤️

**Table of Contents**

1. [Heading 1 💎](#heading-1-)
2. [Heading 2 ❤️](#heading-2-)

# Heading 1 💎
# Heading 2 ❤️

본문

하나의 키워드가 인식되면, 뛰따르는 내용들은 다른 키워드가 나타날 때까지 해당 키워드로 인식됩니다.

사용자 정의 키워드

앞서 헤더에서 선언한 키워드를 사용하여, 해당 섹션이 어떤 키워드에 속하는지 선언할 수 있습니다. 만약 실수로 정의되지 않은 키워드를 사용하거나 키워드 간의 개수가 맞지 않는다면, MMG는 유효성 검사 기능을 통해 오류를 알려줍니다.

<!-- [en] -->
<!-- [ko] -->
<!-- [fr] -->
<!-- [es] -->
<!-- [ja] -->
<!-- [cn] -->
...

공통 영역

생성될 모든 파일에 공통적으로 들어갈 내용은 common 키워드를 사용하여 작성하면 됩니다.

<!-- [common] -->
이 영역에 작성된 내용은 생성될 모든 파일에 공통적으로 들어갑니다.

무시할 영역

주석이나 사소한 메모와 같은 것들은 생성될 파일에 포함하고 싶지 않는 경우가 있습니다. 그런 경우 ignore 키워드를 사용하세요.

<!-- [ignore] -->
이 영역은 생성될 파일에 포함되지 않습니다.