드로어용 콘텐츠 작성
GitLab v19.1GitLab UI에서는 드로어 컴포넌트에 도움말 콘텐츠를 표시할 수 있습니다. 컴포넌트는 Markdown 파일을 가리킵니다. 드로어 콘텐츠는 드로어에서만 표시되며, docs.gitlab.com에는 표시되지 않습니다. GitLab 리포지터리에서 /doc/drawers 폴더로 이동합니다.
GitLab UI에서는 드로어 컴포넌트에 도움말 콘텐츠를 표시할 수 있습니다. Markdown용 컴포넌트는 스토리북에서 확인할 수 있습니다.
컴포넌트는 Markdown 파일을 가리킵니다. Markdown 파일을 업데이트하면 드로어의 콘텐츠가 업데이트됩니다.
드로어 콘텐츠는 드로어에서만 표시되며, docs.gitlab.com에는 표시되지 않습니다.
콘텐츠는 GitLab Flavored Markdown으로 렌더링됩니다.
이 콘텐츠를 작성하려면:
-
GitLab 리포지터리에서
/doc/drawers폴더로 이동합니다. -
Markdown 파일을 생성합니다. 설명적인 파일명을 사용합니다. 하위 폴더를 생성하지 않습니다.
-
표준 페이지 메타데이터를 추가합니다. 또한 다음을 포함합니다:
type: drawer -
콘텐츠를 작성합니다.
-
페이지에
docs.gitlab.com의 다른 페이지에도 있는 콘텐츠가 포함된 경우, 페이지 메타데이터에 다른 파일의 경로를 포함합니다. 예:source: /doc/user/search/global_search/advanced_search_syntax.md -
개발자와 함께 드로어에서 콘텐츠를 확인하고 콘텐츠가 올바르게 표시되는지 검증합니다.
드로어 콘텐츠 가이드라인#
-
파일의 제목은 드로어의 제목으로 사용됩니다.
H1제목은 드로어 타이틀입니다. -
H1에는 일반 텍스트 이외의 문자를 포함하지 않습니다. -
드로어 컴포넌트는 좁고 크기를 조정할 수 없습니다.
테이블을 포함하는 경우, 테이블의 콘텐츠는 간결해야 합니다.
-
사용할 수 있는 문자 수에 기술적인 제한은 없지만, 드로어 콘텐츠를 미리 보기하여 올바르게 렌더링되는지 확인해야 합니다.
-
드로어에서 다른 콘텐츠로 링크를 걸 때는 절대 URL을 사용합니다.
-
Alert 박스나 SVG 아이콘과 같은 Hugo 숏코드를 포함하지 않습니다.