서랍 컨텐츠 만들기

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을 사용하세요.
  • 다음을 포함하지 마세요:
    • 티어 뱃지
    • 히스토리 텍스트
    • 경고 상자
    • 이미지
    • SVG 아이콘