3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 7daf64e760
This commit is contained in:
Website Deployment Script 2018-09-12 02:30:00 +00:00
parent eacccfe97e
commit 527e16ef5b
1214 changed files with 3977 additions and 162321 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/en/site-config.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>siteConfig.js · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="A large part of site configuration is done by editing the `siteConfig.js` file."/><meta name="docsearch:version" content="1.3.3"/><meta name="docsearch:language" content="en"/><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 property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><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="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.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>
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>siteConfig.js · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="A large part of site configuration is done by editing the `siteConfig.js` file."/><meta name="docsearch:version" content="1.4.0"/><meta name="docsearch:language" content="en"/><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 property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><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="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.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>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -12,7 +12,7 @@
{"zIndex":100}
)
});
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/en/versions"><h3>1.3.3</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/installation" target="_self">Docs</a></li><li class=""><a href="/en/help" target="_self">Help</a></li><li class=""><a href="/en/users" target="_self">Users</a></li><li class=""><a href="/en/about-slash" target="_self">About /</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/es-ES/site-config">Español</a></li><li><a href="/docs/ro/site-config">Română</a></li><li><a href="/docs/tr/site-config">Türkçe</a></li><li><a href="/docs/zh-CN/site-config">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Us Translate</a></li></ul></div></li><script>
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/en/versions"><h3>1.4.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/installation" target="_self">Docs</a></li><li class=""><a href="/en/help" target="_self">Help</a></li><li class=""><a href="/en/users" target="_self">Users</a></li><li class=""><a href="/en/about-slash" target="_self">About /</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/es-ES/site-config">Español</a></li><li><a href="/docs/ro/site-config">Română</a></li><li><a href="/docs/tr/site-config">Türkçe</a></li><li><a href="/docs/zh-CN/site-config">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Us Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
@ -24,7 +24,7 @@
languagesDropDown.className = "hide";
}
});
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="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 class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-preparation">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/publishing">Publishing your site</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Guides</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/adding-blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/en/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/en/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/en/translation">Translations &amp; Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/versioning">Versioning</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/commands">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/en/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/en/api-pages">Pages and Styles</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/site-config">siteConfig.js</a></li></ul></div></div></section></div><script>
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="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 class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-preparation">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/publishing">Publishing your site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/docker">Docker</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Guides</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/adding-blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/en/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/en/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/en/translation">Translations &amp; Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/versioning">Versioning</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/commands">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/en/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/en/api-pages">Pages and Styles</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/site-config">siteConfig.js</a></li></ul></div></div></section></div><script>
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
@ -111,6 +111,7 @@
<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>editUrl</code> - URL for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no &quot;Edit this Doc&quot; button for each document.</p>
<p><code>enableUpdateTime</code> - An option to enable the docs showing last update time. Set to <code>true</code> to show a line at the bottom right corner of each doc page as <code>Last Updated: dd/mm/yyyy hh:MM:ss Z</code>.</p>
<p><code>facebookAppId</code> - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a <a href="https://www.facebook.com/help/audiencenetwork/804209223039296">Facebook application id</a>.</p>
<p><code>facebookComments</code> - Set this to <code>true</code> if you want to enable Facebook comments at the bottom of your blog post. <code>facebookAppId</code> has to be also set.</p>
<p><code>facebookPixelId</code> - <a href="https://www.facebook.com/business/a/facebook-pixel">Facebook Pixel</a> ID to track page views.</p>
@ -144,17 +145,18 @@
<li><code>defaultLang</code> defines a default language. It will be used if one is not specified at the top of the code block. You can find the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/languages">list of supported languages here</a>.</li>
<li><code>themeUrl</code> is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the <code>theme</code> and <code>version</code> fields will be ignored.</li>
</ul>
<p><code>manifest</code> - Path to your web app manifest (e.g., <code>/manifest.json</code>). This will add a <code>&lt;link&gt;</code> tag to <code>&lt;head&gt;</code> with <code>rel</code> as <code>&quot;manifest&quot;</code> and <code>content</code> as the provided path.</p>
<p><code>markdownPlugins</code> - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.</p>
<p><code>ogImage</code> - Local path to an Open Graph image (e.g., <code>img/myImage.png</code>). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.</p>
<p><code>onPageNav</code> - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:</p>
<ul>
<li><code>separate</code> - The secondary navigation is a separate pane defaulting on the right side of a document. See <a href="http://docusaurus.io/docs/en/translation.html">http://docusaurus.io/docs/en/translation.html</a> for an example.</li>
</ul>
<p><code>scripts</code> - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.</p>
<p><code>scripts</code> - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.</p>
<p><code>separateCss</code> - Directories inside which any <code>css</code> files will not be processed and concatenated to Docusaurus' styles. This is to support static <code>html</code> pages that may be separate from Docusaurus with completely separate styles.</p>
<p><code>scrollToTop</code> - Set this to <code>true</code> if you want to enable the scroll to top button at the bottom of your site.</p>
<p><code>scrollToTopOptions</code> - Optional options configuration for the scroll to top button. You do not need to use this, even if you set <code>scrollToTop</code> to <code>true</code>; it just provides you more configuration control of the button. You can find more options <a href="https://github.com/vfeskov/vanilla-back-to-top/blob/v7.1.14/OPTIONS.md">here</a>. By default, we set the zIndex option to 100.</p>
<p><code>stylesheets</code> - Array of CSS sources to load. The link tag will be inserted in the HTML head.</p>
<p><code>stylesheets</code> - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.</p>
<p><code>translationRecruitingLink</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>twitter</code> - Set this to <code>true</code> if you want a Twitter social button to appear at the bottom of your blog posts.</p>
<p><code>twitterUsername</code> - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: <code>docusaurus</code>.</p>
@ -228,8 +230,20 @@
};
},
],
<span class="hljs-attr">scripts</span>: [<span class="hljs-string">'https://docusaurus.io/slash.js'</span>],
<span class="hljs-attr">stylesheets</span>: [<span class="hljs-string">'https://docusaurus.io/style.css'</span>],
<span class="hljs-attr">scripts</span>: [
<span class="hljs-string">'https://docusaurus.io/slash.js'</span>,
{
<span class="hljs-attr">src</span>: <span class="hljs-string">'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js'</span>,
<span class="hljs-attr">async</span>: <span class="hljs-literal">true</span>
}
],
<span class="hljs-attr">stylesheets</span>: [
<span class="hljs-string">'https://docusaurus.io/style.css'</span>,
{
<span class="hljs-attr">href</span>: <span class="hljs-string">'http://css.link'</span>,
<span class="hljs-attr">type</span>: <span class="hljs-string">"text/css"</span>
}
],
<span class="hljs-attr">facebookAppId</span>: <span class="hljs-string">'1615782811974223'</span>,
<span class="hljs-attr">facebookComments</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">facebookPixelId</span>: <span class="hljs-string">'352490515235776'</span>,
@ -246,7 +260,7 @@
<span class="hljs-built_in">module</span>.exports = siteConfig;
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/api-pages"><span class="arrow-prev">← </span><span>Previous</span></a></div><p style="font-size:12px;text-align:right"><strong>Last updated: </strong>2018-8-23 03:48:44</p></div></div><nav class="onPageNav docOnPageNav"><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="#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="docs-prevnext"><a class="docs-prev button" href="/docs/en/api-pages"><span class="arrow-prev">← </span><span>Previous</span></a></div><p style="font-size:12px;text-align:right"><strong>Last updated: </strong>2018-9-12 02:13:27</p></div></div><nav class="onPageNav docOnPageNav"><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="#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="
@ -257,6 +271,6 @@
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react',
algoliaOptions: {"facetFilters":["language:en","version:1.3.3"]}
algoliaOptions: {"facetFilters":["language:en","version:1.4.0"]}
});
</script></body></html>