متغيرات البيئة

تقرأ السمة متغيرات البيئة في وقت البناء من config.ts والمكونات المخصصة. تقوم مستودعات المحتوى بتعيين هذه المتغيرات في سير عمل GitHub Actions الخاص بها لتخصيص كل موقع دون تعديل الإعدادات.

مرجع المتغيرات

المتغير	القيمة الافتراضية	الغرض
DOCS_TITLE	Documentation	عنوان الموقع المعروض في الرأس وعلامة تبويب المتصفح
DOCS_SITE	https://f5-sales-demo.github.io	عنوان URL الأساسي الأساسي للموقع المنشور
DOCS_BASE	/	مسار URL الأساسي (مثل /my-repo/ لمواقع المشاريع)
DOCS_DESCRIPTION	(سلسلة فارغة)	وصف الموقع للبيانات الوصفية وإضافة llms.txt
DOCS_HOME	https://f5-sales-demo.github.io/docs/	عنوان URL للصفحة الرئيسية المرتبطة بعنوان الموقع
GITHUB_REPOSITORY	(سلسلة فارغة)	يُستخدم لبناء رابط GitHub الاجتماعي وروابط التعديل
LLMS_OPTIONAL_LINKS	[]	مصفوفة JSON من روابط إضافية لإضافة llms.txt

أين يُستخدم كل متغير

DOCS_TITLE

config.ts

const title = options.title || process.env.DOCS_TITLE || 'Documentation';

يُمرَّر إلى خيار Starlight title وإضافة starlight-llms-txt. يظهر في رأس الموقع وعلامة HTML <title>.

DOCS_SITE

config.ts

const site = options.site || process.env.DOCS_SITE || 'https://f5-sales-demo.github.io';

يضبط خاصية site الرئيسية في Astro. يُستخدم لعناوين URL الأساسية وتوليد خريطة الموقع وبيانات Open Graph الوصفية.

DOCS_BASE

config.ts

const base = options.base || process.env.DOCS_BASE || '/';

يضبط خاصية base الرئيسية في Astro. مطلوب عند النشر في مجلد فرعي (مثل https://example.com/my-repo/).

DOCS_DESCRIPTION

config.ts

const description = options.description || process.env.DOCS_DESCRIPTION || '';

يُمرَّر إلى إضافة starlight-llms-txt بوصفه وصف الموقع. يُستخدم في ملف llms.txt المولَّد.

DOCS_HOME

components/SiteTitle.astro

const docsHome = process.env.DOCS_HOME || 'https://f5-sales-demo.github.io/docs/';

يُقرأ بواسطة المكوّن المخصص SiteTitle.astro. يُغلِّف عنوان الموقع في الرأس برابط إلى عنوان URL هذا، مما يتيح للمستخدمين التنقل للعودة إلى الصفحة الرئيسية المركزية للتوثيق. مفيد عندما تشترك مستودعات محتوى متعددة في نفس السمة وتريد رابط “رئيسية” متسقًا عبر جميع المواقع.

GITHUB_REPOSITORY

config.ts

const githubRepository = options.githubRepository || process.env.GITHUB_REPOSITORY || '';

يُستخدم لتوليد أيقونة GitHub الاجتماعية في رأس الموقع وعنوان URL الأساسي لرابط التعديل. تضبط GitHub Actions هذا المتغير تلقائيًا (مثل owner/repo).

LLMS_OPTIONAL_LINKS

config.ts

const llmsOptionalLinks = options.llmsOptionalLinks
  || (process.env.LLMS_OPTIONAL_LINKS ? JSON.parse(process.env.LLMS_OPTIONAL_LINKS) : []);

مصفوفة مشفَّرة بتنسيق JSON من كائنات { title, url } تُمرَّر إلى إضافة starlight-llms-txt. تظهر هذه الكائنات كروابط إضافية في ملف llms.txt المولَّد.

مثال على القيمة:

[{"title": "API Reference", "url": "https://api.example.com/docs"}]

تعيين المتغيرات في GitHub Actions

تمرِّر مستودعات المحتوى هذه المتغيرات عبر سير عملها:

jobs:
  docs:
    uses: f5-sales-demo/docs-control/.github/workflows/github-pages-deploy.yml@main
    with:
      docs_title: "My Project Docs"
      docs_site: "https://example.com"
      docs_base: "/my-project/"
      docs_home: "https://example.com/home/"

يتوفر متغير GITHUB_REPOSITORY تلقائيًا من خلال مشغِّل GitHub Actions ولا يحتاج إلى تعيينه يدويًا.