Salta ai contenuti

Logo

Il tema visualizza un logo nell’intestazione del sito di ogni sito di documentazione.

Il tema include due file logo nella directory assets/:

FileFormatoDescrizione
assets/f5-logo.svgSVGLogo F5 in Cloud Red (#e4002b)
assets/github-avatar.pngPNGAvatar dell’organizzazione GitHub (predefinito)

Il logo predefinito è impostato nella factory createF5xcDocsConfig in config.ts:

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

Se non viene fornita alcuna opzione logo, viene utilizzato il PNG dell’avatar GitHub. Il percorso è un identificatore di pacchetto npm risolto tramite la mappa exports in package.json.

Passare l’opzione logo a createF5xcDocsConfig:

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

Inserire il file logo nel repository dei contenuti e fare riferimento ad esso:

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

Starlight supporta logo separati per la modalità chiara e scura:

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',
},
});
  • Utilizzare il formato SVG — le immagini raster (PNG, JPG) funzioneranno ma non si ridimensioneranno correttamente a tutte le dimensioni
  • Includere un viewBox — assicura che il logo si ridimensioni proporzionalmente (ad es., viewBox="0 0 100 100")
  • Mantenere le dimensioni del file ridotte — il logo viene caricato su ogni pagina; puntare a meno di 10 KB
  • Testare in entrambi i temi — verificare che il logo appaia correttamente sia in modalità chiara che scura