mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-13 17:17:28 +02:00
62 lines
No EOL
23 KiB
HTML
62 lines
No EOL
23 KiB
HTML
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Translations & Localization · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Translations & Localization · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a `<translate>` tag. Other titles and labels will also be found and properly translated."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="/css/main.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/> <link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body class="sideNavVisible"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/docusaurus.svg"/><h2 class="headerTitle">Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/en/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="/blog" target="_self">Blog</a></li><li><a target="_self"></a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Guides</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-creation.html#content">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/publishing.html#content">Publishing your site</a></li></ul></div><div class="navGroup navGroupActive"><h3>Guides</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/en/blog.html#content">Adding a Blog</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/en/translation.html#content">Translations & Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/en/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/en/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/doc-markdown.html#content">Markdown Features</a></li></ul></div></div></section></div><script>
|
||
var toggler = document.getElementById('navToggler');
|
||
var nav = document.getElementById('docsNav');
|
||
toggler.onclick = function() {
|
||
nav.classList.toggle('docsSliderActive');
|
||
};
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebookexperimental/docusaurus/edit/master/docs/guides-translation.md" target="_blank">Edit this Doc</a><h1>Translations & Localization</h1></header><article><div><p>Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <code><translate></code> tag. Other titles and labels will also be found and properly translated.</p><h2><a class="anchor" name="docusaurus-translation-configurations"></a>Docusaurus Translation Configurations <a class="hash-link" href="#docusaurus-translation-configurations">#</a></h2><p>To generate example files for translations with Docusuaurus, run the <code>examples</code> script with the command line argument <code>translations</code>:</p><pre class="prism language-javascript">npm run examples translations</pre><p>or</p><pre class="prism language-javascript">yarn examples translations</pre><p>This will create the following files:</p><pre class="prism language-javascript">pages<span class="token operator">/</span>en<span class="token operator">/</span>help<span class="token operator">-</span><span class="token keyword">with</span><span class="token operator">-</span>translations<span class="token punctuation">.</span>js
|
||
languages<span class="token punctuation">.</span>js
|
||
crowdin<span class="token punctuation">.</span>yaml</pre><p>The <code>pages/en/help-with-translations.js</code> file includes the same starter help page generated by the <code>examples</code> script, but now includes translation tags.</p><p>The <code>languages.js</code> file tells Docusaurus what languages you want to enable for your site.</p><p>The <code>crowdin.yaml</code> file is used to configure crowdin integration, and is copied up one level into your docusaurus project repo. If your docusaurus project resides in <code>/project/website</code>, then <code>crowdin.yaml</code> will be copied to <code>/project/crowdin.yaml</code>. </p><h2><a class="anchor" name="translating-your-existing-docs"></a>Translating Your Existing Docs <a class="hash-link" href="#translating-your-existing-docs">#</a></h2><p>Your documentation files do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.</p><h2><a class="anchor" name="enabling-translations-on-pages"></a>Enabling Translations on Pages <a class="hash-link" href="#enabling-translations-on-pages">#</a></h2><p>Pages allow you to customize layout and specific content of pages like a custom index page or help page.</p><p>Pages with text that you want translated should be placed in <code>website/pages/en</code> folder.</p><p>Wrap strings you want translated in a <code><translate></code> tag, and add the following <code>require</code> statement to the top of the file:</p><pre class="prism language-jsx"><span class="token operator">...</span>
|
||
<span class="token keyword">const</span> translate <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"../../server/translate.js"</span><span class="token punctuation">)</span><span class="token punctuation">.</span>translate<span class="token punctuation">;</span>
|
||
<span class="token operator">...</span>
|
||
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>h2</span><span class="token punctuation">></span></span>
|
||
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>translate</span><span class="token punctuation">></span></span>This header will be translated<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>translate</span><span class="token punctuation">></span></span>
|
||
<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>h2</span><span class="token punctuation">></span></span>
|
||
<span class="token operator">...</span></pre><p>You can also include an optional description attribute to give more context to a translator about how to translate the string:</p><pre class="prism language-jsx"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>p</span><span class="token punctuation">></span></span>
|
||
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>translate</span> <span class="token attr-name">desc</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>flower, not verb<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>Rose<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>translate</span><span class="token punctuation">></span></span>
|
||
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>p</span><span class="token punctuation">></span></span></pre><h2><a class="anchor" name="gathering-strings-to-translate"></a>Gathering Strings to Translate <a class="hash-link" href="#gathering-strings-to-translate">#</a></h2><p>The strings within localized Pages must be extracted and provided to Crowdin.</p><p>Add the following script to your package.json file:</p><pre class="prism language-json">...
|
||
<span class="token property">"scripts"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
||
<span class="token property">"write-translations"</span><span class="token operator">:</span> <span class="token string">"docusaurus-write-translations"</span>
|
||
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||
...</pre><p>Running the script will generate a <code>website/i18n/en.json</code> file containing all the strings that will be translated from English into other languages.</p><p>The script will include text from the following places:</p><ul><li><code>title</code> and <code>sidebar_label</code> strings in document markdown headers</li><li>category names in <code>sidebars.json</code></li><li>tagline in <code>siteConfig.js</code></li><li>header link <code>label</code> strings in <code>siteConfig.js</code></li><li>strings wrapped in the <code><translate></code> tag in any <code>.js</code> files inside <code>pages</code></li></ul><h2><a class="anchor" name="how-strings-get-translated"></a>How Strings Get Translated <a class="hash-link" href="#how-strings-get-translated">#</a></h2><p>Docusaurus itself does not do any translation from one language to another. Instead, it integrates <a href="https://crowdin.com/" target="_blank">Crowdin</a> to upload translations and then downloads the appropriately translated files from Crowdin.</p><h2><a class="anchor" name="how-docusaurus-uses-string-translations"></a>How Docusaurus Uses String Translations <a class="hash-link" href="#how-docusaurus-uses-string-translations">#</a></h2><p>This section provides context about how translations in Docusaurus works.</p><h3><a class="anchor" name="strings"></a>Strings <a class="hash-link" href="#strings">#</a></h3><p>A Docusaurus site has many strings used throughout it that require localization. However, maintaining a list of strings used through out a site can be laborious. Docusaurus simplies this by centralizing strings.</p><p>The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into <code>i18n/en.json</code>. When your files are translated, say into Spanish, a <code>i18n/fr.json</code> file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').</p><h3><a class="anchor" name="markdown-files"></a>Markdown Files <a class="hash-link" href="#markdown-files">#</a></h3><p>For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.</p><h3><a class="anchor" name="other-pages"></a>Other Pages <a class="hash-link" href="#other-pages">#</a></h3><p>For other pages, Docusaurus will automatically transform all <code><translate></code> tags it finds into function calls that return the translated strings from corresponding localized <em><code>locale</code></em><code>.json</code>.</p><h2><a class="anchor" name="crowdin"></a>Crowdin <a class="hash-link" href="#crowdin">#</a></h2><p>Create your translation project on <a href="https://www.crowdin.com/" target="_blank">Crowdin</a>. You can use <a href="https://support.crowdin.com/translation-process-overview/" target="_blank">Crowdin's guides</a> to learn more about the translations work flow.</p><h3><a class="anchor" name="manual-file-sync"></a>Manual File Sync <a class="hash-link" href="#manual-file-sync">#</a></h3><p>You can add the following to your <code>package.json</code> to manually trigger crowdin. </p><pre class="prism language-json"><span class="token property">"scripts"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
||
<span class="token property">"crowdin-upload"</span><span class="token operator">:</span> <span class="token string">"export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml upload sources --auto-update -b master"</span><span class="token punctuation">,</span>
|
||
<span class="token property">"crowdin-download"</span><span class="token operator">:</span> <span class="token string">"export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml download -b master"</span>
|
||
<span class="token punctuation">}</span><span class="token punctuation">,</span></pre><p>These commands require having an environment variable set with your crowdin project id and api key (<code>CROWDIN_PROJECT_ID</code>, <code>CROWDIN_API_KEY</code>). You can add them inline like above or add them permanently to your <code>.bashrc</code> or <code>.bash_profile</code>.</p><p>If you run more than one localized Docusaurus project on your computer, you should change the name of the enviroment variables to something unique (<code>CROWDIN_DOCUSAURUS_PROJECT_ID</code>, <code>CROWDIN_DOCUSAURUS_API_KEY</code>).</p><h3><a class="anchor" name="automated-file-sync"></a>Automated File Sync <a class="hash-link" href="#automated-file-sync">#</a></h3><p>To automatically get the translations for your files, update the <code>circle.yml</code> file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example <code>circle.yml</code> file:</p><pre class="prism language-yaml"><span class="token key atrule">machine</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">node</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">version</span><span class="token punctuation">:</span> 6.10.3
|
||
<span class="token key atrule">npm</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">version</span><span class="token punctuation">:</span> 3.10.10
|
||
|
||
<span class="token key atrule">test</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">override</span><span class="token punctuation">:</span>
|
||
<span class="token punctuation">-</span> <span class="token string">"true"</span>
|
||
|
||
<span class="token key atrule">deployment</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">website</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">branch</span><span class="token punctuation">:</span> master
|
||
<span class="token key atrule">commands</span><span class="token punctuation">:</span>
|
||
<span spellcheck="true" class="token comment"># configure git user</span>
|
||
<span class="token punctuation">-</span> git config <span class="token punctuation">-</span><span class="token punctuation">-</span>global user.email "test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot@users.noreply.github.com"
|
||
<span class="token punctuation">-</span> git config <span class="token punctuation">-</span><span class="token punctuation">-</span>global user.name "Website Deployment Script"
|
||
<span class="token punctuation">-</span> echo "machine github.com login test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot password $GITHUB_TOKEN" <span class="token punctuation">></span> ~/.netrc
|
||
<span spellcheck="true" class="token comment"># install Docusaurus and generate file of English strings</span>
|
||
<span class="token punctuation">-</span> cd website && npm install && npm run write<span class="token punctuation">-</span>translations && cd ..
|
||
<span spellcheck="true" class="token comment"># crowdin install</span>
|
||
<span class="token punctuation">-</span> sudo apt<span class="token punctuation">-</span>get install default<span class="token punctuation">-</span>jre
|
||
<span class="token punctuation">-</span> wget https<span class="token punctuation">:</span>//artifacts.crowdin.com/repo/deb/crowdin.deb <span class="token punctuation">-</span>O crowdin.deb
|
||
<span class="token punctuation">-</span> sudo dpkg <span class="token punctuation">-</span>i crowdin.deb
|
||
<span spellcheck="true" class="token comment"># translations upload/download</span>
|
||
<span class="token punctuation">-</span> crowdin <span class="token punctuation">-</span><span class="token punctuation">-</span>config crowdin.yaml upload sources <span class="token punctuation">-</span><span class="token punctuation">-</span>auto<span class="token punctuation">-</span>update <span class="token punctuation">-</span>b master
|
||
<span class="token punctuation">-</span> crowdin <span class="token punctuation">-</span><span class="token punctuation">-</span>config crowdin.yaml download <span class="token punctuation">-</span>b master
|
||
<span spellcheck="true" class="token comment"># build and publish website</span>
|
||
<span class="token punctuation">-</span> cd website && GIT_USER=test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot npm run publish<span class="token punctuation">-</span>gh<span class="token punctuation">-</span>pages</pre><p>The <code>crowdin</code> command uses the <code>crowdin.yaml</code> file generated with the <code>examples</code> script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.</p><p>Note that in the <code>crowdin.yaml</code> file, <code>CROWDIN_PROJECT_ID</code> and <code>CROWDIN_API_KEY</code> are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.</p><p>Now, Circle will help you automatically get translations prior to building your website. The provided <code>crowdin.yaml</code> file will copy translated documents into <code>website/translated_docs/</code>, and translated versions of the <code>i18n/en.json</code> strings file will into <code>i18n/${language}.json</code>.</p><p>If you wish to use Crowdin on your machine locally, you can install the <a href="https://support.crowdin.com/cli-tool/" target="_blank">Crowdin CLI tool</a> and run the same commands found in the <code>circle.yaml</code> file. The only difference is that you must set <code>project_identifier</code> and <code>api_key</code> values in the <code>crowdin.yaml</code> file since you will not have Circle environment variables set up. </p><h2><a class="anchor" name="versioned-translations"></a>Versioned Translations <a class="hash-link" href="#versioned-translations">#</a></h2><p>TODO - This section needs to be fleshed out.</p><p>OLD -</p><p>If you wish to have translation and versioning for your documentation, add the following section to the end of your <code>crowdin.yaml</code> file:</p><pre class="prism language-yaml"> <span class="token punctuation">-</span>
|
||
<span class="token key atrule">source</span><span class="token punctuation">:</span> <span class="token string">'/website/versioned_docs/**/*.md'</span>
|
||
<span class="token key atrule">translation</span><span class="token punctuation">:</span> <span class="token string">'/website/translated_docs/%locale%/**/%original_file_name%'</span>
|
||
<span class="token key atrule">languages_mapping</span><span class="token punctuation">:</span> <span class="token important">*anchor</span></pre><p>Translated, versioned documents will be copied into <code>website/translated_docs/${language}/${version}/</code>.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="blog.html#content">← Previous</a><a class="docs-next button" href="search.html#content">Next →</a></div></div></div></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div><h5>Docs</h5><a href="
|
||
/docs/installation.html">Getting Started</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a></div><div><h5>More</h5><a href="https://github.com/facebookexperimental/docusaurus">GitHub</a><a class="github-button" href="https://github.com/facebookexperimental/docusaurus" data-icon="octicon-star" data-count-href="/facebookexperimental/docusaurus/stargazers" data-count-api="/repos/facebookexperimental/docusaurus#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright"><span>Copyright © 2017 Facebook Inc.</span></section></footer></div><script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||
var search = docsearch({
|
||
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
|
||
indexName: 'docusaurus',
|
||
inputSelector: '#search_input_react'
|
||
});
|
||
</script></body></html> |