Skip to content

Docusaurus एकीकरण ​

Docusaurus दस्तावेज़ साइटों के लिए init -t ui-docusaurus और docsOutput.style: "docusaurus" का उपयोग करें। प्रीसेट docs[] ब्लॉक को docusaurusCatalogDir के साथ स्कैफ़ोल्ड करता है ताकि translate-docs एक ही कमांड में पेज मार्कडाउन और Docusaurus शेल JSON दोनों का अनुवाद कर सके।

दस्तावेज़, चलाने योग्य examples/docusaurus-docs डेमो, और examples/nextjs-app को भी देखें, जिसमें नेस्टेड Docusaurus डॉक्स, फ़्लैट README और SVG एसेट के साथ एक संयुक्त Next.js ऐप है।

त्वरित शुरुआत ​

bash
ai-i18n-tools init -t ui-docusaurus -P openai
# edit ai-i18n-tools.config.json (targetLocales, providers, contentPaths, docusaurusCatalogDir)
pnpm run i18n:sync   # or: ai-i18n-tools sync
cd docs-site && pnpm build   # or: cd examples/docusaurus-docs && pnpm build

जब आप दस्तावेज़ीकरण पृष्ठों और साइट शेल स्ट्रिंग (navbar, footer, theme strings) दोनों का अनुवाद करते हैं, तो features.translateDocs को सक्षम करें और docs[].docusaurusCatalogDir सेट करें। जब आप @docusaurus/* को अपग्रेड करते हैं या navbar/footer/theme लेबल बदलते हैं, तो अपने Docusaurus प्रोजेक्ट में docusaurus write-translations चलाएँ — फिर translate-docs या sync को फिर से चलाएँ ताकि शेल JSON प्रत्येक स्थानीय फ़ोल्डर में अनुवादित हो जाए।

पेज लेआउट ​

अंग्रेजी मार्कडाउन और MDX आपके Docusaurus docs/ फ़ोल्डर (उदाहरण के लिए docs-site/docs/) के अंतर्गत रहते हैं। अनुवादित प्रतियाँ प्रत्येक स्थानीय के प्लगइन सामग्री ट्री में लिखी जाती हैं:

text
docs-site/docs/getting-started.md
  →  docs-site/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md
docs-site/docs/guide/quick-start.md
  →  docs-site/i18n/fr/docusaurus-plugin-content-docs/current/guide/quick-start.md

एक docs[] ब्लॉक कॉन्फ़िगर करें:

json
{
  "contentPaths": ["docs-site/docs/"],
  "outputDir": "docs-site/i18n",
  "docusaurusCatalogDir": "docs-site/i18n/en",
  "addFrontmatter": true,
  "docsOutput": {
    "style": "docusaurus",
    "docsRoot": "docs-site/docs"
  }
}

sourceLocale में लिखी गई .md / .mdx फ़ाइलों और डायरेक्टरी पर contentPaths को इंगित करें। वह भाषा कोई भी भाषा हो सकती है। docsRoot को उसी फ़ोल्डर पर सेट करें जिसे Docusaurus अपनी सामग्री रूट के रूप में उपयोग करता है। outputDir को i18n/ के अंतर्गत प्रत्येक स्थानीय फ़ोल्डर के मूल (पैरेंट) पर सेट करें।

Docusaurus अंतर्राष्ट्रीयकरण को वायर करें: ai-i18n-tools.config.json में targetLocales को docusaurus.config.js में locales सरणी के साथ संरेखित रखें। प्रत्येक localeConfigs[locale].path को i18n/ के अंतर्गत फ़ोल्डर नाम से मेल खाना चाहिए (उदाहरण के लिए i18n/fr/ के लिए path: "fr")।

किसी मौजूदा साइट में i18n सक्षम करें ​

पहली बार का सेटअप वेबसाइट या डॉक्स साइट में i18n जोड़ें पर दिए गए प्रॉम्प्ट का उपयोग करता है। नीचे दी गई चेकलिस्ट हाथ से किए गए काम के समान है।

  • docusaurus.config.js में i18n ब्लॉक जोड़ें: defaultLocale, locales, और localeConfigs[locale].path जब URL पाथ स्थानीय कोड से भिन्न होना चाहिए।
  • docusaurus write-translations चलाएँ ताकि i18n/<defaultLocale>/ मौजूद हो, फिर उस फ़ोल्डर पर docusaurusCatalogDir को इंगित करें और sync चलाएँ।
  • src/pages और src/components में कस्टम रिएक्ट मार्कडाउन नहीं है। उपयोगकर्ता-सामना करने वाली कॉपी को @docusaurus/Translate से <Translate> या translate() के साथ चिह्नित करें ताकि write-translations इसे code.json में एकत्र कर सके। संदेश एक स्थिर स्ट्रिंग होना चाहिए। write-translations i18n/<locale>/code.json लिखता है; docusaurusCatalogDir सेट होने पर, translate-docs उस JSON को बाकी शेल कैटलॉग के साथ अनुवादित करता है। ai-i18n-tools उन JSX ट्री को t() के लिए स्कैन नहीं करता है।

शेल स्ट्रिंग्स (write-translations) ​

Docusaurus नेविगेशन बार, फ़ुटर, खोज प्लेसहोल्डर और अन्य थीम/प्लगइन लेबल मार्कडाउन से निकाले नहीं जाते हैं। डिफ़ॉल्ट स्थानीय फ़ोल्डर (आमतौर पर i18n/en/) के अंतर्गत JSON कैटलॉग उत्पन्न करने के लिए अपने Docusaurus प्रोजेक्ट में docusaurus write-translations चलाएँ। फिर docs[].docusaurusCatalogDir को उस फ़ोल्डर पर इंगित करें:

json
{
  "features": {
    "translateDocs": true
  },
  "docs": [
    {
      "description": "Docusaurus pages + shell JSON",
      "contentPaths": ["docs-site/docs/"],
      "outputDir": "docs-site/i18n",
      "docusaurusCatalogDir": "docs-site/i18n/en",
      "docsOutput": {
        "style": "docusaurus",
        "docsRoot": "docs-site/docs"
      }
    }
  ]
}

जब docusaurusCatalogDir सेट होता है और features.translateDocs सक्षम होता है, तो translate-docs दोनों का अनुवाद करता है:

  • दस्तावेज़ पृष्ठ — contentPaths से i18n/<locale>/docusaurus-plugin-content-docs/current/ में मार्कडाउन/MDX
  • शेल JSON — नेविगेशन बार, फ़ुटर, और थीम/प्लगइन कैटलॉग i18n/en/ से सिबलिंग स्थानीय फ़ोल्डरों में

Docusaurus शेल JSON को json[] में न डालें; इसके बजाय दस्तावेज़ों के साथ docs[].docusaurusCatalogDir का उपयोग करें।

उदाहरण प्रोजेक्ट ​

examples/docusaurus-docs — docs/ पर अंग्रेजी स्रोत, i18n/<locale>/docusaurus-plugin-content-docs/current/ के अंतर्गत प्रतिबद्ध अनुवाद, साथ ही अनुवादित शेल JSON। पोर्ट 3100 पर pnpm start चलाएँ (बिल्ड + सर्व) ताकि स्थानीय ड्रॉपडाउन काम करे; केवल अंग्रेजी हॉट रीलोड के लिए pnpm dev का उपयोग करें।

UI स्ट्रिंग्स, SVG अनुवाद, और उसी रिपॉजिटरी लेआउट में एक फ़्लैट README के लिए, examples/nextjs-app (पोर्ट 3040 पर नेस्टेड docs-site/) देखें।

MIT लाइसेंस के तहत जारी किया गया।