mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-01 10:22:30 +02:00
update website [ci skip]
This commit is contained in:
Facebook GitHub Bot
parent
3de45c3798
commit
a0562c3b02
25 changed files with 166 additions and 42 deletions
|
|
@ -1,4 +1,4 @@
|
|||
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>siteConfig.js · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="siteConfig.js · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="A large part of site configuration is done by editing the `siteConfig.js` file."/><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="stylesheet" href="/css/custom.css"/><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>API</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></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"><a class="navItem" 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 navListItemActive"><a class="navItem navItemActive" 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>
|
||||
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>siteConfig.js · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="siteConfig.js · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="A large part of site configuration is done by editing the `siteConfig.js` file."/><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>API</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></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"><a class="navItem" 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 navListItemActive"><a class="navItem navItemActive" 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() {
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
<span class="token punctuation">{</span> search<span class="token punctuation">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||
<span spellcheck="true" class="token comment">// Determines language drop down position among links</span>
|
||||
<span class="token punctuation">{</span> languages<span class="token punctuation">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span>
|
||||
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><p><code>headerIcon</code> - url for icon used in header navigation bar.</p><p><code>favicon</code> - url for site favicon.</p><p><code>colors</code> - Color configurations for the site.</p><ul><li><code>primaryColor</code> is the color used the header navigation bar and sidebars. </li><li><code>secondaryColor</code> is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). </li><li><code>prismColor</code> is the color used in the background of syntax highlighting for code in documentation. It is recommended to be the same color as <code>primaryColor</code> in <code>rgba</code> form with an alpha value of <code>0.03</code>. Other fields can be added</li><li>Custom color configurations can also be added. For example, if user styles are added with colors specified as <code>$myColor</code>, then adding a <code>myColor</code> field to <code>colors</code> will allow you to easily configure this color.</li></ul><h3><a class="anchor" name="optional-fields"></a>Optional Fields <a class="hash-link" href="#optional-fields">#</a></h3><p><code>editUrl</code> - url for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no "Edit this Doc" button for each document.</p><p><code>users</code> - The <code>users</code> array mentioned earlier.</p><p><code>disableHeaderTitle</code> - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to <code>true</code>.</p><p><code>disableTitleTagline</code> - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as <code>Title • Tagline</code>. Set to <code>true</code> to make page titles just <code>Title</code>.</p><p><code>separateCss</code> - Folders inside which any <code>css</code> files will not be processed and concatenated to Docusaurus's styles. This is to support static <code>html</code> pages that may be separate from Docusaurus with completely separate styles.</p><p><code>footerIcon</code> - url for a footer icon. Currently used in the <code>core/Footer.js</code> file provided as an example, but it can be removed from that file.</p><p><code>recruitingLink</code> - url for the <code>Help Translate</code> tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.</p><p><code>algolia</code> - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.</p><p><code>gaTrackingId</code> - Google Analytics tracking ID to track page views.</p><p>Users can also add their own custom fields if they wish to provide some data across different files.</p><h2><a class="anchor" name="example-siteconfigjs-with-all-fields"></a>Example siteConfig.js with all fields <a class="hash-link" href="#example-siteconfigjs-with-all-fields">#</a></h2><pre class="prism language-javascript"><span class="token keyword">const</span> users <span class="token operator">=</span> <span class="token punctuation">[</span>
|
||||
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><p><code>headerIcon</code> - url for icon used in header navigation bar.</p><p><code>favicon</code> - url for site favicon.</p><p><code>colors</code> - Color configurations for the site.</p><ul><li><code>primaryColor</code> is the color used the header navigation bar and sidebars. </li><li><code>secondaryColor</code> is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). </li><li><code>prismColor</code> is the color used in the background of syntax highlighting for code in documentation. It is recommended to be the same color as <code>primaryColor</code> in <code>rgba</code> form with an alpha value of <code>0.03</code>. Other fields can be added</li><li>Custom color configurations can also be added. For example, if user styles are added with colors specified as <code>$myColor</code>, then adding a <code>myColor</code> field to <code>colors</code> will allow you to easily configure this color.</li></ul><p><code>copyright</code> - The copyright string at footer of site and within feed</p><h3><a class="anchor" name="optional-fields"></a>Optional Fields <a class="hash-link" href="#optional-fields">#</a></h3><p><code>editUrl</code> - url for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no "Edit this Doc" button for each document.</p><p><code>users</code> - The <code>users</code> array mentioned earlier.</p><p><code>disableHeaderTitle</code> - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to <code>true</code>.</p><p><code>disableTitleTagline</code> - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as <code>Title • Tagline</code>. Set to <code>true</code> to make page titles just <code>Title</code>.</p><p><code>separateCss</code> - Folders inside which any <code>css</code> files will not be processed and concatenated to Docusaurus's styles. This is to support static <code>html</code> pages that may be separate from Docusaurus with completely separate styles.</p><p><code>footerIcon</code> - url for a footer icon. Currently used in the <code>core/Footer.js</code> file provided as an example, but it can be removed from that file.</p><p><code>recruitingLink</code> - url for the <code>Help Translate</code> tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.</p><p><code>algolia</code> - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.</p><p><code>gaTrackingId</code> - Google Analytics tracking ID to track page views.</p><p>Users can also add their own custom fields if they wish to provide some data across different files.</p><h2><a class="anchor" name="example-siteconfigjs-with-all-fields"></a>Example siteConfig.js with all fields <a class="hash-link" href="#example-siteconfigjs-with-all-fields">#</a></h2><pre class="prism language-javascript"><span class="token keyword">const</span> users <span class="token operator">=</span> <span class="token punctuation">[</span>
|
||||
<span class="token punctuation">{</span>
|
||||
caption<span class="token punctuation">:</span> <span class="token string">"User1"</span><span class="token punctuation">,</span>
|
||||
image<span class="token punctuation">:</span> <span class="token string">"/test-site/img/docusaurus.svg"</span><span class="token punctuation">,</span>
|
||||
|
|
@ -68,7 +68,7 @@
|
|||
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
||||
|
||||
module<span class="token punctuation">.</span>exports <span class="token operator">=</span> siteConfig<span class="token punctuation">;</span></pre></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="api-pages.html#content">← Previous</a><a class="docs-next button" href="doc-markdown.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">Copyright © 2017 Facebook Inc.</section></footer></div><script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||||
/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',
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue