InfoGrab DocsInfoGrab Docs

Markdown과 목록

GitLab 문서의 Markdown, 제목 수준, 목록 규칙을 설명합니다.

Markdown # 모든 GitLab 문서는 Markdown 으로 작성합니다. 문서 웹사이트 는 Hugo 정적 사이트 생성기와 기본 Markdown 엔진인 Goldmark 를 사용합니다. Markdown 서식은 markdownlint 와 Vale 로 테스트합니다. Markdown 안의 HTML # 하드코딩된 HTML도 유효하지만, 다음과 같은 이유로 권장하지 않습니다. 사용자 지정 마크업은 향후 사이트 전체 변경이나 디자인 시스템 업데이트를 깨뜨릴 수 있습니다. 사용자 지정 마크업에는 사이트 전반의 일관성을 보장하는 테스트 범위가 없습니다. 사용자 지정 마크업은 반응형이 아니거나 접근성을 갖추지 못할 수 있습니다. 사용자 지정 마크업은 Pajamas 지침을 따르지 않을 수 있습니다. Markdown 안의 HTML과 CSS는 /help 에서 렌더링되지 않습니다. HTML을 직접 작성하면 오류가 생기기 쉽습니다. 잘못된 HTML로 페이지 레이아웃이나 다른 구성 요소가 깨질 수 있습니다. 다음 경우에는 HTML을 허용합니다. Markdown에 이에 해당하는 기능이 없는 경우 테크니컬 라이터가 콘텐츠를 검토하고 승인한 경우 사용자 지정 요소가 시급하게 필요하고 Technical Writing 엔지니어의 구현을 기다릴 수 없는 경우 HTML <a> 태그로 만드는 모든 링크는 href 속성에 절대 URL을 사용해야 합니다. 일반 링크와 달리 Markdown 파일로의 상대 링크는 사용하지 않습니다. Hugo는 Markdown 형식의 링크만 처리하고 바꿀 수 있기 때문입니다. Docs 사이트에 유용할 새 요소에 대한 아이디어나 요청이 있으면 기능 요청 을 제출합니다. Markdown의 제목 수준 # 각 문서 페이지에는 메타데이터 에 title 속성이 있어야 합니다. title 은 HTML로 렌더링될 때 H1 요소가 됩니다. 페이지마다 H1 은 하나만 있을 수 있으므로 Markdown에 H1 제목을 추가하지 않습니다. 하위 섹션마다 제목 수준을 하나씩 높입니다. 즉, 토픽 제목 앞의 # 문자 수를 하나씩 늘립니다. H5 ( ##### )보다 큰 제목 수준은 사용하지 않도록 합니다. 제목 수준이 다섯 개를 넘게 필요하면 토픽을 새 페이지로 옮깁니다. H4 보다 큰 제목 수준은 오른쪽 사이드바 탐색에 표시되지 않습니다. 수준을 건너뛰지 않습니다. 예: ## > #### . 토픽 제목 앞뒤에 빈 줄을 하나씩 둡니다. 토픽 제목에 코드를 사용하면 코드를 백틱으로 감쌉니다. 토픽 제목에는 굵은 텍스트를 사용하지 않습니다. 제목이 목차(TOC)에 나타나지 않게 하려면 제목 텍스트 뒤에 `` 속성을 추가합니다. ## My heading 제목은 페이지에 그대로 렌더링되지만 TOC에서는 제외됩니다. Markdown의 설명 목록 # 용어를 정의하거나 옵션을 구분하려면 설명 목록을 사용합니다. UI 요소 목록에는 설명 목록 대신 일반 목록 을 사용합니다. 설명 목록을 다른 스타일과 섞어 쓰지 않습니다. Term 1 : Definition of Term 1 Term