mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-02 10:52:35 +02:00
Website Deployment Script
parent
b695034586
commit
540f7da203
28 changed files with 200 additions and 4 deletions
|
|
@ -157,6 +157,19 @@
|
|||
</code></pre>
|
||||
<h4><a class="anchor" aria-hidden="true" id="defaultversionshown-string"></a><a href="#defaultversionshown-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>defaultVersionShown</code> [string]</h4>
|
||||
<p>The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="deleteddocs-object"></a><a href="#deleteddocs-object" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>deletedDocs</code> [object]</h4>
|
||||
<p>Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to <a href="versioning#fallback-functionality">fallback functionality</a>. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.</p>
|
||||
<p>To force removal of content beginning with a certain version (including for current/next), add a <code>deletedDocs</code> object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="hljs css language-js">{
|
||||
<span class="hljs-attr">deletedDocs</span>: {
|
||||
<span class="hljs-string">"2.0.0"</span>: [
|
||||
<span class="hljs-string">"tagging"</span>
|
||||
]
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>The version keys must match those in <code>versions.json</code>. Assuming the versions list in <code>versions.json</code> is <code>["3.0.0", "2.0.0", "1.1.0", "1.0.0"]</code>, the <code>docs/1.0.0/tagging</code> and <code>docs/1.1.0/tagging</code> URLs will work but <code>docs/2.0.0/tagging</code>, <code>docs/3.0.0/tagging</code>, and <code>docs/tagging</code> will not. The files and folders for those versions will not be generated during the build.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="docsurl-string"></a><a href="#docsurl-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docsUrl</code> [string]</h4>
|
||||
<p>The base URL for all docs file. Set this field to <code>''</code> to remove the <code>docs</code> prefix of the documentation URL. If unset, it is defaulted to <code>docs</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="disableheadertitle-boolean"></a><a href="#disableheadertitle-boolean" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>disableHeaderTitle</code> [boolean]</h4>
|
||||
|
|
@ -388,7 +401,7 @@
|
|||
|
||||
<span class="hljs-built_in">module</span>.exports = siteConfig;
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 4/8/2020 by Reece Dunham</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Pages and Styles</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#adding-google-fonts">Adding Google Fonts</a></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/25/2020 by Eric Dobbertin</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Pages and Styles</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#adding-google-fonts">Adding Google Fonts</a></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -157,6 +157,19 @@
|
|||
</code></pre>
|
||||
<h4><a class="anchor" aria-hidden="true" id="defaultversionshown-string"></a><a href="#defaultversionshown-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>defaultVersionShown</code> [string]</h4>
|
||||
<p>The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="deleteddocs-object"></a><a href="#deleteddocs-object" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>deletedDocs</code> [object]</h4>
|
||||
<p>Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to <a href="versioning#fallback-functionality">fallback functionality</a>. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.</p>
|
||||
<p>To force removal of content beginning with a certain version (including for current/next), add a <code>deletedDocs</code> object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="hljs css language-js">{
|
||||
<span class="hljs-attr">deletedDocs</span>: {
|
||||
<span class="hljs-string">"2.0.0"</span>: [
|
||||
<span class="hljs-string">"tagging"</span>
|
||||
]
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>The version keys must match those in <code>versions.json</code>. Assuming the versions list in <code>versions.json</code> is <code>["3.0.0", "2.0.0", "1.1.0", "1.0.0"]</code>, the <code>docs/1.0.0/tagging</code> and <code>docs/1.1.0/tagging</code> URLs will work but <code>docs/2.0.0/tagging</code>, <code>docs/3.0.0/tagging</code>, and <code>docs/tagging</code> will not. The files and folders for those versions will not be generated during the build.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="docsurl-string"></a><a href="#docsurl-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docsUrl</code> [string]</h4>
|
||||
<p>The base URL for all docs file. Set this field to <code>''</code> to remove the <code>docs</code> prefix of the documentation URL. If unset, it is defaulted to <code>docs</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="disableheadertitle-boolean"></a><a href="#disableheadertitle-boolean" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>disableHeaderTitle</code> [boolean]</h4>
|
||||
|
|
@ -388,7 +401,7 @@
|
|||
|
||||
<span class="hljs-built_in">module</span>.exports = siteConfig;
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 4/8/2020 by Reece Dunham</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Pages and Styles</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#adding-google-fonts">Adding Google Fonts</a></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/25/2020 by Eric Dobbertin</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Pages and Styles</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#adding-google-fonts">Adding Google Fonts</a></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,6 +124,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="fallback-functionality"></a><a href="#fallback-functionality" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Fallback Functionality</h2>
|
||||
<p>Only files in the <code>docs</code> directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.</p>
|
||||
<p>For example, a document with the original id <code>doc1</code> exists for the latest version, <code>1.0.0</code>, and has the same content as the document with the id <code>doc1</code> in the <code>docs</code> directory. When a new version <code>2.0.0</code> is created, the file for <code>doc1</code> will not be copied into <code>versioned_docs/version-2.0.0/</code>. There will still be a page for <code>docs/2.0.0/doc1.html</code>, but it will use the file from version <code>1.0.0</code>.</p>
|
||||
<p>Because of the way this fallback works, pages that you delete are not really deleted from the website unless you tell Docusaurus to skip fallback after a certain version. To do this, use the <a href="/docs/en/next/site-config#deleteddocs-object"><code>deletedDocs</code></a> option in <code>siteConfig.js</code>.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="renaming-existing-versions"></a><a href="#renaming-existing-versions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Renaming Existing Versions</h2>
|
||||
<p>To rename an existing version number to something else, first make sure the following script is in your <code>package.json</code> file:</p>
|
||||
<pre><code class="hljs css language-js">...
|
||||
|
|
@ -137,7 +138,7 @@
|
|||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="versioning-and-translations"></a><a href="#versioning-and-translations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Versioning and Translations</h2>
|
||||
<p>If you wish to use versioning and translations features, the <code>crowdin.yaml</code> file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory <code>translated_docs/${language}/version-${version}/</code>. For more information, check out the <a href="/docs/en/next/translation">translations guide</a>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/10/2018 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/translation"><span class="arrow-prev">← </span><span>Translations & Localization</span></a><a class="docs-next button" href="/docs/en/next/commands"><span>CLI Commands</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-create-new-versions">How to Create New Versions</a></li><li><a href="#versioning-patterns">Versioning Patterns</a></li><li><a href="#storing-files-for-each-version">Storing Files for Each Version</a></li><li><a href="#fallback-functionality">Fallback Functionality</a></li><li><a href="#renaming-existing-versions">Renaming Existing Versions</a></li><li><a href="#versioning-and-translations">Versioning and Translations</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/25/2020 by Eric Dobbertin</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/translation"><span class="arrow-prev">← </span><span>Translations & Localization</span></a><a class="docs-next button" href="/docs/en/next/commands"><span>CLI Commands</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-create-new-versions">How to Create New Versions</a></li><li><a href="#versioning-patterns">Versioning Patterns</a></li><li><a href="#storing-files-for-each-version">Storing Files for Each Version</a></li><li><a href="#fallback-functionality">Fallback Functionality</a></li><li><a href="#renaming-existing-versions">Renaming Existing Versions</a></li><li><a href="#versioning-and-translations">Versioning and Translations</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,6 +124,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="fallback-functionality"></a><a href="#fallback-functionality" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Fallback Functionality</h2>
|
||||
<p>Only files in the <code>docs</code> directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.</p>
|
||||
<p>For example, a document with the original id <code>doc1</code> exists for the latest version, <code>1.0.0</code>, and has the same content as the document with the id <code>doc1</code> in the <code>docs</code> directory. When a new version <code>2.0.0</code> is created, the file for <code>doc1</code> will not be copied into <code>versioned_docs/version-2.0.0/</code>. There will still be a page for <code>docs/2.0.0/doc1.html</code>, but it will use the file from version <code>1.0.0</code>.</p>
|
||||
<p>Because of the way this fallback works, pages that you delete are not really deleted from the website unless you tell Docusaurus to skip fallback after a certain version. To do this, use the <a href="/docs/en/next/site-config#deleteddocs-object"><code>deletedDocs</code></a> option in <code>siteConfig.js</code>.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="renaming-existing-versions"></a><a href="#renaming-existing-versions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Renaming Existing Versions</h2>
|
||||
<p>To rename an existing version number to something else, first make sure the following script is in your <code>package.json</code> file:</p>
|
||||
<pre><code class="hljs css language-js">...
|
||||
|
|
@ -137,7 +138,7 @@
|
|||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="versioning-and-translations"></a><a href="#versioning-and-translations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Versioning and Translations</h2>
|
||||
<p>If you wish to use versioning and translations features, the <code>crowdin.yaml</code> file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the directory <code>translated_docs/${language}/version-${version}/</code>. For more information, check out the <a href="/docs/en/next/translation">translations guide</a>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/10/2018 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/translation"><span class="arrow-prev">← </span><span>Translations & Localization</span></a><a class="docs-next button" href="/docs/en/next/commands"><span>CLI Commands</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-create-new-versions">How to Create New Versions</a></li><li><a href="#versioning-patterns">Versioning Patterns</a></li><li><a href="#storing-files-for-each-version">Storing Files for Each Version</a></li><li><a href="#fallback-functionality">Fallback Functionality</a></li><li><a href="#renaming-existing-versions">Renaming Existing Versions</a></li><li><a href="#versioning-and-translations">Versioning and Translations</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 6/25/2020 by Eric Dobbertin</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/translation"><span class="arrow-prev">← </span><span>Translations & Localization</span></a><a class="docs-next button" href="/docs/en/next/commands"><span>CLI Commands</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#how-to-create-new-versions">How to Create New Versions</a></li><li><a href="#versioning-patterns">Versioning Patterns</a></li><li><a href="#storing-files-for-each-version">Storing Files for Each Version</a></li><li><a href="#fallback-functionality">Fallback Functionality</a></li><li><a href="#renaming-existing-versions">Renaming Existing Versions</a></li><li><a href="#versioning-and-translations">Versioning and Translations</a></li></ul></nav></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 class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue