<h2 class="anchor anchorTargetHideOnScrollNavbar_qJOx" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview" translate=no></a></h2>
8
<p><code>docusaurus.config.js</code> contains configurations for your site and is placed in the root directory of your site.</p>
9
<div class="theme-admonition theme-admonition-note admonition_o5H7 alert alert--secondary"><div class=admonitionHeading_FzoX><span class=admonitionIcon_rXq6><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_Knsx><p>With a <a class="" href=/docs/typescript-support>TypeScript</a> Docusaurus codebase your config file may be called <code>docusaurus.config.ts</code>. The syntax is broadly identical to the <code>js</code> config file with the addition of typ
10
<p>This file is <strong>run in Node.js</strong> and should export a site configuration object, or a function that creates it.</p>
<p>The base URL of your site is the path segment appearing just after the <a href=#url class=""><code>url</code></a>, letting you eventually host your site under a subpath instead of at the root of the domain.</p>
40
<p>For example, let's consider you want to host a site at <a href=https://facebook.github.io/metro/ target=_blank rel="noopener noreferrer" class="">https://facebook.github.io/metro/</a>, then you must configure it accordingly:</p>
41
<ul>
42
<li class=""><a href=#url class=""><code>url</code></a> should be <code>'https://facebook.github.io'</code></li>
43
<li class=""><code>baseUrl</code> should be <code>'/metro/'</code></li>
83
<ul>
84
<li class=""><code>label</code>: The label displayed for this locale in the locales dropdown.</li>
85
<li class=""><code>direction</code>: <code>ltr</code> (default) or <code>rtl</code> (for <a href=https://developer.mozilla.org/en-US/docs/Glossary/rtl target=_blank rel="noopener noreferrer" class="">right-to-left languages</a> like Farsi, Arabic, Hebrew, etc.). Used to select the locale's CSS and HTML meta attribute.</li>
86
<li class=""><code>htmlLang</code>: BCP 47 language tag to use in <code><html lang="..."></code> (or any other DOM tag name) and in <code><link ... hreflang="..."></code></li>
87
<li class=""><code>calendar</code>: the <a href=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar target=_blank rel="noopener noreferrer" class="">calendar</a> used to calculate the date era. Note that it doesn't control the actual string displayed: <code>MM/DD/YYYY</code> and <code>DD/MM/YYYY</code> are both <code>gregory</code>. To choose the format (<code>DD/MM/YYYY</code> or <code>MM/DD/YYYY</code>), set your locale name to <code>en-GB</code> or <code>en-US</code> (<code>en</code> means <code>en-US</code>).</li>
<h2 class="anchor anchorTargetHideOnScrollNavbar_qJOx" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview" translate=no></a></h2>
8
<p><code>docusaurus.config.js</code> contains configurations for your site and is placed in the root directory of your site.</p>
9
<div class="theme-admonition theme-admonition-note admonition_o5H7 alert alert--secondary"><div class=admonitionHeading_FzoX><span class=admonitionIcon_rXq6><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_Knsx><p>With a <a class="" href=/docs/typescript-support>TypeScript</a> Docusaurus codebase your config file may be called <code>docusaurus.config.ts</code>. The syntax is broadly identical to the <code>js</code> config file with the addition of typ
10
<p>This file is <strong>run in Node.js</strong> and should export a site configuration object, or a function that creates it.</p>
<h2 class="anchor anchorTargetHideOnScrollNavbar_qJOx" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview" translate=no></a></h2>
8
<p><code>docusaurus.config.js</code> contains configurations for your site and is placed in the root directory of your site.</p>
9
<div class="theme-admonition theme-admonition-note admonition_o5H7 alert alert--secondary"><div class=admonitionHeading_FzoX><span class=admonitionIcon_rXq6><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_Knsx><p>With a <a class="" href=/docs/typescript-support>TypeScript</a> Docusaurus codebase your config file may be called <code>docusaurus.config.ts</code>. The syntax is broadly identical to the <code>js</code> config file with the addition of typ
10
<p>This file is <strong>run in Node.js</strong> and should export a site configuration object, or a function that creates it.</p>
<h2 class="anchor anchorTargetHideOnScrollNavbar_qJOx" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview" translate=no></a></h2>
8
<p><code>docusaurus.config.js</code> contains configurations for your site and is placed in the root directory of your site.</p>
9
<div class="theme-admonition theme-admonition-note admonition_o5H7 alert alert--secondary"><div class=admonitionHeading_FzoX><span class=admonitionIcon_rXq6><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_Knsx><p>With a <a class="" href=/docs/typescript-support>TypeScript</a> Docusaurus codebase your config file may be called <code>docusaurus.config.ts</code>. The syntax is broadly identical to the <code>js</code> config file with the addition of typ
10
<p>This file is <strong>run in Node.js</strong> and should export a site configuration object, or a function that creates it.</p>
<li class=""><code>label</code>: The label displayed for this locale in the locales dropdown.</li>
85
<li class=""><code>direction</code>: <code>ltr</code> (default) or <code>rtl</code> (for <a href=https://developer.mozilla.org/en-US/docs/Glossary/rtl target=_blank rel="noopener noreferrer" class="">right-to-left languages</a> like Farsi, Arabic, Hebrew, etc.). Used to select the locale's CSS and HTML meta attribute.</li>
86
<li class=""><code>htmlLang</code>: BCP 47 language tag to use in <code><html lang="..."></code> (or any other DOM tag name) and in <code><link ... hreflang="..."></code></li>
87
<li class=""><code>calendar</code>: the <a href=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar target=_blank rel="noopener noreferrer" class="">calendar</a> used to calculate the date era. Note that it doesn't control the actual string displayed: <code>MM/DD/YYYY</code> and <code>DD/MM/YYYY</code> are both <code>gregory</code>. To choose the format (<code>DD/MM/YYYY</code> or <code>MM/DD/YYYY</code>), set your locale name to <code>en-GB</code> or <code>en-US</code> (<code>en</code> means <code>en-US</code>).</li>
<h2 class="anchor anchorTargetHideOnScrollNavbar_qJOx" id=overview>Overview<a href=#overview class=hash-link aria-label="Direct link to Overview" title="Direct link to Overview" translate=no></a></h2>
8
<p><code>docusaurus.config.js</code> contains configurations for your site and is placed in the root directory of your site.</p>
9
<div class="theme-admonition theme-admonition-note admonition_o5H7 alert alert--secondary"><div class=admonitionHeading_FzoX><span class=admonitionIcon_rXq6><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_Knsx><p>With a <a class="" href=/docs/typescript-support>TypeScript</a> Docusaurus codebase your config file may be called <code>docusaurus.config.ts</code>. The syntax is broadly identical to the <code>js</code> config file with the addition of typ
10
<p>This file is <strong>run in Node.js</strong> and should export a site configuration object, or a function that creates it.</p>