コンテンツにスキップ

ロゴ

テーマは、すべてのドキュメントサイトのサイトヘッダーにロゴを表示します。

テーマには assets/ ディレクトリに2つのロゴファイルが同梱されています:

ファイルフォーマット説明
assets/f5-logo.svgSVGCloud Red(#e4002b)の F5 ロゴ
assets/github-avatar.pngPNGGitHub 組織のアバター(デフォルト)

デフォルトのロゴは config.ts 内の createF5xcDocsConfig ファクトリで設定されています:

const logo = options.logo || { src: '@f5-sales-demo/docs-theme/assets/github-avatar.png' };

logo オプションが指定されていない場合、GitHub アバターの PNG が使用されます。パスは package.jsonexports マップを通じて解決される npm パッケージ指定子です。

オプション 1: F5 SVG ロゴを使用する

Section titled “オプション 1: F5 SVG ロゴを使用する”

createF5xcDocsConfiglogo オプションを渡します:

import { createF5xcDocsConfig } from '@f5-sales-demo/docs-theme/config';
export default createF5xcDocsConfig({
logo: { src: '@f5-sales-demo/docs-theme/assets/f5-logo.svg' },
});

オプション 2: カスタムロゴを使用する

Section titled “オプション 2: カスタムロゴを使用する”

ロゴファイルをコンテンツリポジトリに配置し、参照します:

import { createF5xcDocsConfig } from '@f5-sales-demo/docs-theme/config';
export default createF5xcDocsConfig({
logo: { src: './src/assets/my-logo.svg' },
});

オプション 3: ライトモードとダークモードで別々のロゴを使用する

Section titled “オプション 3: ライトモードとダークモードで別々のロゴを使用する”

Starlight はライトモードとダークモードで別々のロゴをサポートしています:

import { createF5xcDocsConfig } from '@f5-sales-demo/docs-theme/config';
export default createF5xcDocsConfig({
logo: {
light: './src/assets/logo-light.svg',
dark: './src/assets/logo-dark.svg',
},
});
  • SVG フォーマットを使用する — ラスター画像(PNG、JPG)も使用できますが、すべてのサイズできれいにスケールされません
  • viewBox を含める — ロゴが比例してスケールされることを保証します(例:viewBox="0 0 100 100"
  • ファイルサイズを小さく保つ — ロゴはすべてのページで読み込まれます。10 KB 以下を目標にしてください
  • 両方のテーマでテストする — ライトモードとダークモードの両方でロゴが正しく表示されることを確認してください