引き出し用コンテンツの作成
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 を使ってください。
- を含めないでください：
- ティアバッジ
- バージョン履歴テキスト
- アラートボックス
- 画像
- SVGアイコン