Skip to content

इंटीग्रेशन

डॉक्यूमेंटेशन साइटों और एस्ट्रो प्रोजेक्ट्स में ai-i18n-tools को जोड़ने के लिए फ्रेमवर्क-विशिष्ट गाइड। प्रत्येक इंटीग्रेशन पेज सामग्री के लिए डॉक्यूमेंट्स पाइपलाइन (translate-docs / sync) का उपयोग करता है; शेल स्ट्रिंग्स (नेविगेशन, साइडबार, थीम) को उसी पाइपलाइन के भीतर संभाला जाता है जहाँ नोट किया गया है — अलग JSON पाइपलाइन के माध्यम से नहीं।

कौन सी गाइड पढ़ें

आपकी साइटप्रारंभिक टेम्पलेटयहां से शुरू करें
एस्ट्रो स्टारलाइट या सादा एस्ट्रोui-starlight / हाइब्रिड UI स्ट्रिंग्सएस्ट्रो
डॉक्यूसॉरसui-docusaurusडॉक्यूसॉरस
वाइटप्रेसui-vitepressवाइटप्रेस
नेक्सट्रा 4 (नेक्स्ट.जेएस ऐप राउटर)ui-nextraनेक्सट्रा
फुमाडॉक्स 4 (नेक्स्ट.जेएस ऐप राउटर)ui-fumadocsफुमाडॉक्स

साझा अवधारणाएं

सभी डॉक्यूमेंटेशन-फ्रेमवर्क इंटीग्रेशन डॉक्यूमेंट्स में वर्णित समान docs[] ब्लॉक मॉडल साझा करते हैं। अपने फ्रेमवर्क ("docusaurus", "vitepress", "nextra", "fumadocs", या "astro-starlight") से मिलान करने के लिए docsOutput.style सेट करें। आउटपुट फ़ोल्डर लेआउट और लिंक रीराइटिंग व्यवहार के लिए, आउटपुट लेआउट और लिंक रीराइटिंग देखें।

प्रत्येक init -t ui-* टेम्पलेट एक डिफ़ॉल्ट LLM प्रदाता ब्लॉक (openrouter जब तक आप -P <provider> पास नहीं करते) को स्कैफ़ोल्ड करता है। translate-docs या sync से पहले, यदि आवश्यक हो तो provider / providers को कॉन्फ़िगर करें और मिलान करने वाली API कुंजी सेट करें — प्रदाता और API कुंजी देखें।

क्रॉस-फ्रेमवर्क तुलना के लिए फ्रेमवर्क शेल अनुवाद देखें। नीचे दिया गया प्रत्येक लिंक किया गया गाइड उस फ्रेमवर्क के लिए सेटअप को कवर करता है।

फ्रेमवर्क शेल अनुवाद

फ्रेमवर्कशेल / थीम स्ट्रिंग्सपाइपलाइन
डॉक्यूसॉरसwrite-translations कैटलॉग ({ message, description })डॉक्यूमेंट्स — docs[].docusaurusCatalogDir + translate-docs
वाइटप्रेसथीम/नेविगेशन/साइडबार कैटलॉगडॉक्यूमेंट्स — docsOutput.vitepressThemeCatalog + translate-docs
नेक्सट्रा_meta.ts साइडबार लेबलडॉक्यूमेंट्स — style: "nextra" + translate-docs होने पर ऑटो
नेक्सट्राथीम डिक्शनरी .tsडॉक्यूमेंट्स — docs[].nextraDictionaryPath + translate-docs
फुमाडॉक्सmeta.json साइडबार लेबलडॉक्यूमेंट्स — style: "fumadocs" + translate-docs होने पर ऑटो
फुमाडॉक्सUI ओवरराइड कैटलॉगडॉक्यूमेंट्स — docsOutput.fumadocsUiCatalog + translate-docs
एस्ट्रो स्टारलाइटबिल्ट-इन UI स्ट्रिंग्स (कई लोकेल); कोई अतिरिक्त शेल पाइपलाइन नहींडॉक्यूमेंट्स — translate-docs (केवल पेज)

फ्रेमवर्क शेल/थीम स्ट्रिंग्स को json[] में डालें — वह पाइपलाइन असंबंधित ऐप लोकेल बंडलों के लिए है। प्रति-फ्रेमवर्क सेटअप विवरण कौन सा गाइड पढ़ना है से लिंक किए गए गाइड में हैं।

चलाने योग्य उदाहरण

फ़्रेमवर्कउदाहरण रेपो
Astro Starlightexamples/astro-docs
सामान्य Astro वेबसाइटexamples/astro-website
Docusaurusexamples/docusaurus-docs
VitePressexamples/vitepress-docs
Nextraexamples/nextra-docs
Fumadocsexamples/fumadocs-docs

एमआईटी लाइसेंस के तहत जारी किया गया।