पर्यावरण चर

थीम 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	[]	llms.txt प्लगइन के लिए अतिरिक्त लिंक की JSON एरे

प्रत्येक चर का उपयोग कहाँ होता है

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';

Astro की शीर्ष-स्तरीय site प्रॉपर्टी सेट करता है। कैनोनिकल URLs, साइटमैप जनरेशन और Open Graph मेटाडेटा के लिए उपयोग किया जाता है।

DOCS_BASE

config.ts

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

Astro की शीर्ष-स्तरीय base प्रॉपर्टी सेट करता है। किसी उपनिर्देशिका में डिप्लॉय करते समय आवश्यक (जैसे, https://example.github.io/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) : []);

{ title, url } ऑब्जेक्ट की JSON-एन्कोडेड एरे जो 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.github.io"
      docs_base: "/my-project/"
      docs_home: "https://example.github.io/home/"

GITHUB_REPOSITORY चर GitHub Actions रनर द्वारा स्वचालित रूप से प्रदान किया जाता है और इसे मैन्युअल रूप से सेट करने की आवश्यकता नहीं है।