드로어(Drawer) 콘텐츠 만들기
GitLab UI에서 드로어(Drawer) 컴포넌트에 도움말 콘텐츠를 표시할 수 있습니다. Markdown을 위한 컴포넌트는 storybook에 있습니다.
이 컴포넌트는 Markdown 파일을 가리킵니다. Markdown 파일을 업데이트할 때마다 드로어(Drawer)의 내용이 업데이트됩니다.
드로어(Drawer) 콘텐츠는 드로어(Drawer)에만 표시되며 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
- 드로어(Drawer)에서 콘텐츠를 보고 콘텐츠가 올바르게 나타나는지 확인하기 위해 개발자와 협업합니다.
드로어(Drawer) 콘텐츠 지침
- 파일의 헤딩은 드로어(Drawer)의 헤딩으로 사용됩니다.
H1
헤딩은 드로어(Drawer) 제목입니다. -
H1
에 일반 텍스트 이외의 문자를 포함시키지 마십시오. - 드로어(Drawer) 컴포넌트는 좁으며 크기를 조절할 수 없습니다.
- 테이블을 포함하는 경우 내용은 간결해야 합니다.
- 사용할 수 있는 글자 수에 대한 기술적 제약은 없지만, 드로어(Drawer) 콘텐츠가 잘 렌더링되는지 미리보기할 필요가 있습니다.
- 드로어(Drawer)에서 다른 콘텐츠로 연결하려면 절대 URL을 사용하십시오.
- 다음을 포함하지 마십시오:
- 티어 뱃지
- 이력 텍스트
- 경고 상자
- 이미지
- SVG 아이콘