ข้ามไปยังเนื้อหา

โลโก้

ธีมจะแสดงโลโก้ในส่วนหัวของเว็บไซต์เอกสารทุกแห่ง

ธีมมาพร้อมกับไฟล์โลโก้สองไฟล์ในไดเรกทอรี assets/:

ไฟล์รูปแบบคำอธิบาย
assets/f5-logo.svgSVGโลโก้ F5 ในสี Cloud Red (#e4002b)
assets/github-avatar.pngPNGอวตารองค์กร GitHub (ค่าเริ่มต้น)

โลโก้เริ่มต้นถูกกำหนดไว้ใน factory createF5xcDocsConfig ใน config.ts:

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

หากไม่มีการระบุตัวเลือก logo จะใช้ GitHub avatar PNG โดยเส้นทางนี้เป็น npm package specifier ที่ถูก resolve ผ่าน exports map ใน package.json

ส่งตัวเลือก logo ไปยัง createF5xcDocsConfig:

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

วางไฟล์โลโก้ของคุณในที่เก็บเนื้อหาและอ้างอิงดังนี้:

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

ตัวเลือกที่ 3: แยกโลโก้สำหรับโหมดสว่างและโหมดมืด

หัวข้อที่มีชื่อว่า “ตัวเลือกที่ 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 — รูปภาพแบบ raster (PNG, JPG) สามารถใช้งานได้แต่จะไม่ปรับขนาดได้อย่างคมชัดในทุกขนาด
  • ใส่ viewBox — เพื่อให้โลโก้ปรับขนาดได้อย่างสมส่วน (เช่น viewBox="0 0 100 100")
  • รักษาขนาดไฟล์ให้เล็ก — โลโก้จะโหลดในทุกหน้า ควรตั้งเป้าไว้ที่ไม่เกิน 10 KB
  • ทดสอบในทั้งสองธีม — ตรวจสอบให้แน่ใจว่าโลโก้แสดงผลได้อย่างถูกต้องทั้งในโหมดสว่างและโหมดมืด