서랍의 콘텐츠 만들기

GitLab UI에서 서랍 구성요소에 도움말 콘텐츠를 표시할 수 있습니다.

Markdown용 구성요소는 스토리북에 있습니다.

이 구성요소는 Markdown 파일을 가리킵니다. Markdown 파일을 업데이트할 때마다 서랍의 내용이 업데이트됩니다.

서랍 콘텐츠는 서랍에서만 표시되며 docs.gitlab.com에서는 표시되지 않습니다.

콘텐츠는 GitLab Flavored Markdown으로 렌더링됩니다.

이 콘텐츠를 생성하려면:

  1. GitLab 리포지토리에서, /doc/drawers 폴더로 이동합니다.

  2. Markdown 파일을 생성합니다. 설명적인 파일 이름을 사용합니다. 하위 폴더를 만들지 마십시오.

  3. 표준 페이지 메타데이터를 추가합니다. 또한 포함:

    type: drawer
  4. 콘텐츠를 저작합니다.

  5. 페이지에 docs.gitlab.com의 페이지와 동일한 콘텐츠가 포함된 경우, 페이지 메타데이터에서 다른 파일에 대한 경로를 포함합니다. 예를 들어:

    source: /doc/user/search/global_search/advanced_search_syntax.md
  6. 개발자와 함께 작업하여 서랍에서 콘텐츠를 확인하고 내용이 올바르게 표시되는지 확인합니다.

서랍 콘텐츠 지침

  • 파일의 제목은 서랍의 제목으로 사용됩니다. H1 제목은 서랍 제목입니다.

  • H1에는 일반 텍스트 외의 다른 문자를 포함하지 마십시오.

  • 서랍 구성요소는 좁고 크기를 조절할 수 없습니다.

    • 표를 포함하는 경우, 그 안의 내용은 간결해야 합니다.

    • 사용할 수 있는 문자 수에 대한 기술적 제한은 없지만, 서랍 콘텐츠를 미리 보고 잘 렌더링되는지 확인해야 합니다.

  • 서랍에서 다른 콘텐츠로 링크하려면 절대 URL을 사용합니다.

  • 포함하지 마십시오:

    • Tier 배지

    • 히스토리 텍스트

    • 경고 상자

    • 이미지

    • SVG 아이콘