पहले कदम

Starlight Astro फ्रेमवर्क के शीर्ष पर निर्मित एक पूर्ण-विशेषीकृत दस्तावेज़ीकरण थीम है। यह मार्गदर्शिका आपको एक नई परियोजना शुरू करने में मदद करेगी। मौजूदा Astro परियोजना में Starlight जोड़ने के लिए मैन्युअल सेटअप निर्देश देखें।

जल्दी शुरुआत करें

एक नयी परियोजना बनाएं

अपने टर्मिनल में निम्नलिखित आदेश चलाकर एक नयी Astro + Starlight परियोजना बनाएं:

npm

npm create astro@latest -- --template starlight

pnpm

pnpm create astro --template starlight

Yarn

yarn create astro --template starlight

यह आपकी साइट के लिए सभी आवश्यक फ़ाइलों और कॉन्फ़िगरेशन के साथ एक नई परियोजना निर्देशिका बनाएगा।

इसे क्रियान्वित करके देखें

अपने ब्राउज़र में Starlight आज़माएँ: StackBlitz पर टेम्पलेट खोलें.

विकास सर्वर शुरू करें

स्थानीय स्तर पर काम करते समय, Astro का विकास सर्वर आपको अपने काम का पूर्वावलोकन करने देता है और जब आप परिवर्तन करते हैं तो स्वचालित रूप से आपके ब्राउज़र को रीफ्रेश करता है।

अपनी परियोजना निर्देशिका के अंदर, विकास सर्वर शुरू करने के लिए निम्नलिखित कमांड चलाएँ:

npm

npm run dev

pnpm

pnpm dev

Yarn

yarn dev

यह आपके स्थानीय पूर्वावलोकन के URL के साथ आपके टर्मिनल पर एक संदेश लॉग करेगा। अपनी साइट ब्राउज़ करने के लिए इस URL को खोलें।

सामग्री जोड़ें

Starlight आपके लिए नई सामग्री जोड़ने, या अपनी मौजूदा फ़ाइलें लाने के लिए तैयार है!

फ़ाइल स्वरूप

Starlight बिना किसी कॉन्फ़िगरेशन की आवश्यकता के Markdown और MDX में सामग्री लिखने का समर्थन करता है। आप प्रायोगिक Astro Markdoc एकीकरण स्थापित करके Markdoc के लिए समर्थन जोड़ सकते हैं।

पेज जोड़ें

src/content/docs/ में .md या .mdx फ़ाइलें बनाकर अपनी साइट पर नए पेज जोड़ें। अपनी फ़ाइलों को व्यवस्थित करने और एकाधिक पथ खंड बनाने के लिए उप-फ़ोल्डर्स का उपयोग करें।

उदाहरण के लिए, निम्नलिखित फ़ाइल संरचना example.com/hello-world और example.com/guides/faq पर पेज बनाएगी:

• Directorysrc/

  • Directorycontent/

    • Directorydocs/

      • Directoryguides/

        • faq.md
      • hello-world.md

टाइप-सुरक्षित फ्रंटमैटर

सभी Starlight पेज फ्रंटमैटर गुणों का एक अनुकूलन योग्य सामान्य सेट साझा करते हैं पेज के प्रकट होने के तरीके को नियंत्रित करने के लिए:

---
title: नमस्ते, दुनिया !
description: यह मेरी Starlight-संचालित साइट का एक पेज है
---

यदि आप कुछ भी महत्वपूर्ण भूल जाते हैं, तो Starlight आपको बता देगा।

अगले कदम

• कॉन्फ़िगर: “कस्टमाइज़िंग स्टारलाइट” में सामान्य विकल्पों के बारे में जानें।
• नेविगेट: “साइडबार नेविगेशन” गाइड के साथ अपना साइडबार सेट करें।
• अवयवों: “अवयवों” मार्गदर्शिका में अंतर्निहित कार्ड, टैब और बहुत कुछ खोजें।
• डिप्लॉय: Astro Docs में “अपनी साइट परिनियोजित करें” मार्गदर्शिका के साथ अपना कार्य प्रकाशित करें।

Starlight को अद्यतन करें

संकेत

क्योंकि Starlight बीटा सॉफ्टवेयर है, इसमें लगातार अपडेट और सुधार होते रहेंगे। Starlight को नियमित रूप से अपडेट करना सुनिश्चित रखे!

Starlight एक Astro एकीकरण है, और इसे किसी भी @astrojs/* एकीकरण की तरह अद्यतन किया जाता है:

npm

npm install @astrojs/starlight@latest

pnpm

pnpm upgrade @astrojs/starlight --latest

Yarn

yarn upgrade @astrojs/starlight --latest

प्रत्येक रिलीज़ में किए गए परिवर्तनों की पूरी सूची के लिए Starlight चेंजलॉग देखें।

समस्या निवारण Starlight में

यह सुनिश्चित करने के लिए कि आपकी Starlight साइट कॉन्फ़िगर है और ठीक से काम कर रही है, परियोजना कॉन्फ़िगरेशन और व्यक्तिगत पेज फ्रंटमैटर कॉन्फ़िगरेशन संदर्भ पेजो का उपयोग करें। सामग्री जोड़ने और अपनी स्टारलाइट साइट को अनुकूलित करने में सहायता के लिए साइडबार में मार्गदर्शिकाएँ देखें।

यदि आपका उत्तर इन दस्तावेज़ों में नहीं मिल सकता है, तो संपूर्ण Astro दस्तावेज़ीकरण के लिए कृपया Astro दस्तावेज़ देखें। आपके प्रश्न का उत्तर यह समझकर दिया जा सकता है कि इस Starlight थीम के तहत Astro सामान्य रूप से कैसे काम करता है।

आप GitHub पर किसी ज्ञात Starlight समस्या की भी जांच कर सकते हैं, और हमारे सक्रिय, मैत्रीपूर्ण समुदाय से Astro Discord में सहायता प्राप्त कर सकते हैं! हमारे #support फोरम में “Starlight” टैग के साथ प्रश्न पोस्ट करें, या वर्तमान विकास और अधिक पर चर्चा करने के लिए हमारे समर्पित #Starlight चैनल पर जाएँ!