mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-02 02:42:41 +02:00
update website [ci skip]
This commit is contained in:
Facebook GitHub Bot
commit
f060894394
40 changed files with 2747 additions and 0 deletions
1
CNAME
Normal file
1
CNAME
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
docusaurus.io
|
||||||
1960
css/main.css
Normal file
1960
css/main.css
Normal file
File diff suppressed because it is too large
Load diff
35
docs/api-pages.html
Normal file
35
docs/api-pages.html
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Pages and Styles · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Pages and Styles · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus provides support for writing pages as React components inside the `website/pages` folder which will share the same header, footer, and styles as the rest of the site."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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/api-pages.md" target="_blank">Edit this Doc</a><h1>Pages and Styles</h1></header><article><div><p>Docusaurus provides support for writing pages as React components inside the <code>website/pages</code> folder which will share the same header, footer, and styles as the rest of the site.</p><h2><a class="anchor" name="urls-for-pages"></a>Urls for Pages <a class="hash-link" href="#urls-for-pages">#</a></h2><p>Any <code>.js</code> files in <code>website/pages</code> will be rendered to static html using the path of the file after "pages". Files in <code>website/pages/en</code> will also get copied out into <code>pages</code> and will OVERRIDE any files of the same name in <code>pages</code>. For example, the page for the <code>website/pages/en/help.js</code> file will be found at the url <code>${baseUrl}en/help.js</code> as well as the url <code>${baseUrl}help.js</code>, where <code>${baseUrl}</code> is the <code>baseUrl</code> field set in your <a href="/docs/site-config.html" target="">siteConfig.js file</a>.</p><h2><a class="anchor" name="page-require-paths"></a>Page Require Paths <a class="hash-link" href="#page-require-paths">#</a></h2><p>Docusaurus provides a few useful React components for users to write their own pages, found in the <code>CompLibrary</code> module. This module is provided as part of Docusaurus in <code>node_modules/docusaurus</code>, so to access it, pages in the <code>pages</code> folder are temporarily copied into <code>node_modules/docusaurus</code> when rendering to static html. As seen in the example files, this means that a user page at <code>pages/en/index.js</code> uses a require path to <code>"../../core/CompLibrary.js"</code> to import the provided components.</p><p>What this means to the user is that if you wish to use the <code>CompLibrary</code> module, make sure the require path is set correctly. For example, a page at <code>page/mypage.js</code> would use a path <code>"../core/CompLibrary.js"</code>.</p><p>If you wish to use your own components inside the website folder, use <code>process.cwd()</code> which will refer to the <code>website</code> folder to construct require paths. For example, if you add a component to <code>website/core/mycomponent.js</code>, you can use the require path, <code>"process.cwd() + /core/mycomponent.js"</code>.</p><h2><a class="anchor" name="provided-components"></a>Provided Components <a class="hash-link" href="#provided-components">#</a></h2><p>Docusaurus provides the following components in <code>CompLibrary</code>:</p><h3><a class="anchor" name="complibrarymarked"></a><code>CompLibrary.Marked</code> <a class="hash-link" href="#complibrarymarked">#</a></h3><p>A React component that parses Markdown to html.</p><p>Example:</p><pre class="prism language-jsx"><span class="token keyword">const</span> Marked <span class="token operator">=</span> CompLibrary<span class="token punctuation">.</span>Marked<span class="token punctuation">;</span>
|
||||||
|
|
||||||
|
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>Marked</span><span class="token punctuation">></span></span><span class="token punctuation">[</span>Markdown syntax <span class="token keyword">for</span> a link<span class="token punctuation">]</span><span class="token punctuation">(</span>http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>www<span class="token punctuation">.</span>example<span class="token punctuation">.</span>com<span class="token punctuation">)</span><span class="token tag"><span class="token tag"><span class="token punctuation"></</span>Marked</span><span class="token punctuation">></span></span></pre><h3><a class="anchor" name="complibrarycontainer"></a><code>CompLibrary.Container</code> <a class="hash-link" href="#complibrarycontainer">#</a></h3><p>A React container component using Docusaurus styles. Has optional padding and background color attributes that you can configure.</p><p>Padding choices: <code>all</code>, <code>bottom</code>, <code>left</code>, <code>right</code>, <code>top</code>.<br/>Background choices: <code>dark</code>, <code>highlight</code>, <code>light</code>.</p><p>Example:</p><pre class="prism language-jsx"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>Container</span> <span class="token attr-name">padding</span><span class="token script language-javascript"><span class="token punctuation">=</span><span class="token punctuation">{</span><span class="token punctuation">[</span><span class="token string">"bottom"</span><span class="token punctuation">,</span> <span class="token string">"top"</span><span class="token punctuation">]</span><span class="token punctuation">}</span></span> <span class="token attr-name">background</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>light<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>Container</span><span class="token punctuation">></span></span></pre><h3><a class="anchor" name="complibrarygridblock"></a><code>CompLibrary.GridBlock</code> <a class="hash-link" href="#complibrarygridblock">#</a></h3><p>A React component to organize text and images. </p><p>The <code>align</code> attribute determines text alignment. Text alignment defaults to <code>left</code> and can be set to <code>center</code> or <code>right</code>.</p><p>The <code>layout</code> attribute determines number of column sections per GridBlock. <code>layout</code> defaults to <code>twoColumn</code> and can be set to <code>threeColumn</code> or <code>fourColumn</code> as well.</p><p>The <code>contents</code> attribute is an array containing the contents of each section of the GridBlock. Each content object can have the following fields: </p><ul><li><code>content</code> for the text of this section, which is parsed from markdown</li><li><code>image</code> for the path to an image to display </li><li><code>imageAlign</code> field for image alignment relative to the text, which defaults to <code>top</code> and can be set to <code>bottom</code>, <code>left</code>, or <code>right</code></li><li><code>title</code> for the title to display for this section, which is parsed from markdown</li><li><code>imageLink</code> for a link destination from clicking the image</li></ul><p>Example:</p><pre class="prism language-javascript"><span class="token operator"><</span>GridBlock
|
||||||
|
align<span class="token operator">=</span><span class="token string">"center"</span>
|
||||||
|
contents<span class="token operator">=</span><span class="token punctuation">{</span><span class="token punctuation">[</span>
|
||||||
|
<span class="token punctuation">{</span>
|
||||||
|
content<span class="token punctuation">:</span> <span class="token string">"Learn how to use this project"</span><span class="token punctuation">,</span>
|
||||||
|
image<span class="token punctuation">:</span> siteConfig<span class="token punctuation">.</span>baseUrl <span class="token operator">+</span> <span class="token string">"img/learn.png"</span><span class="token punctuation">,</span>
|
||||||
|
title<span class="token punctuation">:</span> <span class="token template-string"><span class="token string">`[Learn](</span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span>siteConfig<span class="token punctuation">.</span>baseUrl<span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">docs/tutorial.html)`</span></span><span class="token punctuation">,</span>
|
||||||
|
imageLink<span class="token punctuation">:</span> siteConfig<span class="token punctuation">.</span>baseUrl <span class="token operator">+</span> <span class="token string">"docs/tutorial.html"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">{</span>
|
||||||
|
content<span class="token punctuation">:</span> <span class="token string">"Questions gathered from the community"</span><span class="token punctuation">,</span>
|
||||||
|
image<span class="token punctuation">:</span> siteConfig<span class="token punctuation">.</span>baseUrl <span class="token operator">+</span> <span class="token string">"img/faq.png"</span><span class="token punctuation">,</span>
|
||||||
|
imageAlign<span class="token punctuation">:</span> <span class="token string">"top"</span><span class="token punctuation">,</span>
|
||||||
|
title<span class="token punctuation">:</span> <span class="token string">"Frequently Asked Questions"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">{</span>
|
||||||
|
content<span class="token punctuation">:</span> <span class="token string">"Lots of documentation is on this site"</span><span class="token punctuation">,</span>
|
||||||
|
title<span class="token punctuation">:</span> <span class="token string">"More"</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">}</span>
|
||||||
|
layout<span class="token operator">=</span><span class="token string">"threeColumn"</span>
|
||||||
|
<span class="token operator">/</span><span class="token operator">></span></pre><p>More examples of how these components are used can be found in the <a href="/docs/site-preparation.html" target="">generated example files</a> as well as in Docusaurus's own repo for its website set-up.</p><h2><a class="anchor" name="translating-strings"></a>Translating Strings <a class="hash-link" href="#translating-strings">#</a></h2><p>When translations are enabled, any pages inside <code>website/pages/en</code> will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the <code>languages.js</code> file. E.g. The url for a French page of <code>website/pages/en/help.js</code> would be found at <code>${baseUrl}fr/help.html</code>.</p><p>When writing pages that you wish to translate, wrap any strings to be translated inside a <code><translate></code> tag. e.g.,</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 punctuation">></span></span>I like translations<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><p>You can also provide an optional description attribute to provide context for translators. e.g,</p><pre class="prism language-jsx"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>a</span> <span class="token attr-name">href</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>/community<span class="token punctuation">"</span></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>footer link to page referring to community github and slack<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>Community<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>a</span><span class="token punctuation">></span></span></pre><p>Add the following require statement as well:</p><pre class="prism language-js"><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></pre><p>Note that this path is valid for files inside <code>pages/en</code> and should be adjusted accordingly if files are in different locations, as discussed <a href="#page-require-paths" target="">above</a>.</p><h2><a class="anchor" name="using-static-assets"></a>Using Static Assets <a class="hash-link" href="#using-static-assets">#</a></h2><p>Static assets should be placed into the <code>website/static</code> folder. They can be accesssed by their paths, excluding "static". For example, if the site's <code>baseUrl</code> is "/docusaurus/", an image in <code>website/static/img/logo.png</code> is available at <code>/docusaurus/img/logo.png</code>.</p><h2><a class="anchor" name="styles"></a>Styles <a class="hash-link" href="#styles">#</a></h2><p>You should configure your site's primary, secondary, and Prism colors using the <code>colors</code> field in <code>siteConfig</code> as specified <a href="site-config.md" target="_blank">here</a>. You can also configure other colors in the same way as described in the <code>siteConfig</code> doc.</p><p>You can provide your own custom styles by adding them anywhere in the <code>website/static</code> folder. Any <code>.css</code> files you provide in the <code>static</code> folder will get concatenated to the end of Docusaurus's provided styles, allowing you to add to or override Docusaurus default styles as you wish.</p><p>An easy way to figure out what classes you wish to override or add to is to <a href="/docs/commands.html" target="">start your server locally</a> and use your browser's inspect element tool.</p><h2><a class="anchor" name="adding-static-pages"></a>Adding Static Pages <a class="hash-link" href="#adding-static-pages">#</a></h2><p>Static <code>.html</code> files can also be used, but they will not include Docusaurus's header, footer, or styles by default. These can be added to the <code>static</code> folder in the same way as other static assets. Alternatively, they can be placed in the <code>pages</code> folder and would be served as-is instead of being rendered from React.</p><p>If you wish to use Docusaurus's stylesheet, you can access it at <code>${baseUrl}css/main.css</code>. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus's styles by adding them into the <code>siteConfig.separateCss</code> field.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="commands.html#content">← Previous</a><a class="docs-next button" href="site-config.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></body></html>
|
||||||
33
docs/blog.html
Normal file
33
docs/blog.html
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Adding a Blog · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Adding a Blog · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## Initial Setup"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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-blog.md" target="_blank">Edit this Doc</a><h1>Adding a Blog</h1></header><article><div><h2><a class="anchor" name="initial-setup"></a>Initial Setup <a class="hash-link" href="#initial-setup">#</a></h2><p>To setup your site's blog, start by creating a <code>blog</code> folder within your repo's <code>website</code> directory.</p><p>Then, add a header link to your blog within <code>siteConfig.js</code>:</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">{</span>blog<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Blog'</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">]</span></pre><h2><a class="anchor" name="adding-blog-posts"></a>Adding blog posts <a class="hash-link" href="#adding-blog-posts">#</a></h2><p>To publish in the blog, create a file within the blog folder with a formatted name of <code>YYYY-MM-DD-My-Blog-Post-Title.md</code>. The post date is extracted from the file name.</p><p>For example, we will create the following file <code>website/blog/2017-08-18-Introducing-Docusaurus.md</code>:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
author<span class="token punctuation">:</span> Frank Li
|
||||||
|
authorURL<span class="token punctuation">:</span> https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>twitter<span class="token punctuation">.</span>com<span class="token operator">/</span>foobarbaz
|
||||||
|
authorFBID<span class="token punctuation">:</span> <span class="token number">503283835</span>
|
||||||
|
title<span class="token punctuation">:</span> Introducing Docusaurus
|
||||||
|
<span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
|
||||||
|
Lorem Ipusm<span class="token punctuation">.</span><span class="token punctuation">.</span></pre><h2><a class="anchor" name="blog-post-summaries"></a>Blog Post Summaries <a class="hash-link" href="#blog-post-summaries">#</a></h2><p>Use the <code><!--truncate--></code> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <code><!--truncate--></code> will be part of the summary. For example:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
title<span class="token punctuation">:</span> Truncation Exmaple
|
||||||
|
<span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
|
||||||
|
All <span class="token keyword">this</span> will be part <span class="token keyword">of</span> the blog post summary<span class="token punctuation">.</span>
|
||||||
|
|
||||||
|
Even <span class="token keyword">this</span><span class="token punctuation">.</span>
|
||||||
|
|
||||||
|
<span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span>truncate<span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
|
||||||
|
But anything <span class="token keyword">from</span> here on down will not be<span class="token punctuation">.</span>
|
||||||
|
|
||||||
|
Not <span class="token keyword">this</span><span class="token punctuation">.</span>
|
||||||
|
|
||||||
|
Or <span class="token keyword">this</span><span class="token punctuation">.</span></pre><h2><a class="anchor" name="special-blog-post-header-options"></a>Special blog post header options <a class="hash-link" href="#special-blog-post-header-options">#</a></h2><p>The only required field is <code>title</code>; however, we provide options to add author information to your blog post as well.</p><ul><li><code>author</code> - The text label of the author byline.</li><li><code>authorURL</code> - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.</li><li><code>authorFBID</code> - The Facebook ID that is used to extract the profile picture.</li><li><code>title</code> - The blog post title.</li></ul></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="navigation.html#content">← Previous</a><a class="docs-next button" href="translation.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></body></html>
|
||||||
8
docs/commands.html
Normal file
8
docs/commands.html
Normal file
File diff suppressed because one or more lines are too long
16
docs/custom-pages.html
Normal file
16
docs/custom-pages.html
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Custom Pages · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Custom Pages · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## Customizing Your Home Page"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-creation.html#content">Creating your site</a></li></ul></div><div class="navGroup navGroupActive"><h3>Guides</h3><ul><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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-custom-pages.md" target="_blank">Edit this Doc</a><h1>Custom Pages</h1></header><article><div><h2><a class="anchor" name="customizing-your-home-page"></a>Customizing Your Home Page <a class="hash-link" href="#customizing-your-home-page">#</a></h2><p>The easiest way to get started customizing your home page is to use the <a href="/docs/site-creation.html" target="">examples generated previously</a>. You can start your local server and go to <code>http://localhost:3000</code> to see what the example home page looks like. From there, edit the <code>website/pages/en/index.js</code> file and its various components to use the images and text you want for your project.</p><h2><a class="anchor" name="adding-other-custom-pages"></a>Adding Other Custom Pages <a class="hash-link" href="#adding-other-custom-pages">#</a></h2><p>Docusaurus provides some simple example pages (<code>index.js</code>, <code>users.js</code>, <code>help.js</code>), but of course you're also free to write your own pages however you want. It is strongly suggested that you at least have an index page, but none of the pages are mandatory to include. More information on how to use the provided components or include your own can be found <a href="/docs/api-pages.html" target="">here</a>. Information on how to link to your different pages in the header navigation bar can be found <a href="/docs/navigation.html" target="">here</a>.</p><h2><a class="anchor" name="customizing-your-site-footer"></a>Customizing Your Site Footer <a class="hash-link" href="#customizing-your-site-footer">#</a></h2><p>Starting from the example <code>core/Footer.js</code> file you <a href="/docs/site-creation.html" target="">generated before</a>, edit the footer to include any links to pages on your site or elsewhere that you wish to have. </p><p>The example provided has three columns with a footer image on the left and Facebook's open source logo and copyright at the bottom. If your project is not a Facebook open source project, remove the logo and copyright. Otherwise, feel free to get creative with your footer and make it look however you'd like!</p><p>Some suggestions for links you may want to provide: documentation, API, Twitter, Discord, Facebook groups, Stack Overflow, GitHub, etc.</p><p>Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.</p><p>If you don't want a footer for your site, change the <code>render</code> function of <code>core/Footer.js</code> to return <code>null</code>. e.g.,</p><pre class="prism language-jsx"><span class="token keyword">const</span> React <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"react"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||||||
|
|
||||||
|
<span class="token keyword">class</span> <span class="token class-name">Footer</span> <span class="token keyword">extends</span> <span class="token class-name">React<span class="token punctuation">.</span>Component</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token function">render</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token keyword">return</span> <span class="token keyword">null</span><span class="token punctuation">;</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
|
||||||
|
module<span class="token punctuation">.</span>exports <span class="token operator">=</span> Footer<span class="token punctuation">;</span></pre></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="site-creation.html#content">← Previous</a><a class="docs-next button" href="navigation.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></body></html>
|
||||||
30
docs/doc-markdown.html
Normal file
30
docs/doc-markdown.html
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Markdown Features · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Markdown Features · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## Markdown Headers"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/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/api-doc-markdown.md" target="_blank">Edit this Doc</a><h1>Markdown Features</h1></header><article><div><h2><a class="anchor" name="markdown-headers"></a>Markdown Headers <a class="hash-link" href="#markdown-headers">#</a></h2><h2><a class="anchor" name="documents"></a>Documents <a class="hash-link" href="#documents">#</a></h2><p>Documents use the following markdown header fields that are enclosed by a line <code>---</code> on either side:</p><p><code>id</code>: A unique document id. If this field is not present, the document's <code>id</code> will default to it's file name (without the extension).</p><p><code>title</code>: The title of your document. If this field is not present, the document's <code>title</code> will default to it's <code>id</code>.</p><p><code>sidebar_label</code>: The text shown in the document sidebar for this document. If this field is not present, the document's <code>sidebar_label</code> will default to it's <code>title</code>.</p><p>For example:</p><pre class="prism language-markup">---
|
||||||
|
id: doc1
|
||||||
|
title: My Document
|
||||||
|
sidebar_label: Document
|
||||||
|
---</pre><p>Versioned documents have their ids altered to include the version number when they get copied. The new <code>id</code> is <code>version-${version}-${id}</code> where <code>${version}</code> is the version number of that document and <code>${id}</code> is the original <code>id</code>. Additionally, versioned documents get an added <code>original_id</code> field with the original document id.</p><p>For example:</p><pre class="prism language-markup">---
|
||||||
|
id: version-1.0.0-doc1
|
||||||
|
title: My Document
|
||||||
|
sidebar_label: Document
|
||||||
|
original_id: doc1
|
||||||
|
---</pre><h2><a class="anchor" name="blog-posts"></a>Blog Posts <a class="hash-link" href="#blog-posts">#</a></h2><p>Blog Posts use the following markdown header fields that are enclosed by a line <code>---</code> on either side:</p><p><code>title</code>: The title of this blog post.</p><p><code>author</code>: The author of this blog post. If this field is omitted, no author name will be shown.</p><p><code>authorURL</code>: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.</p><p><code>authorFBID</code>: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post.</p><p>For example:</p><pre class="prism language-markup">---
|
||||||
|
title: My First Blog Post
|
||||||
|
author: Frank Li
|
||||||
|
authorURL: http://twitter.com/franchementli
|
||||||
|
authorFBID: 100002976521003
|
||||||
|
---</pre><h2><a class="anchor" name="extra-features"></a>Extra Features <a class="hash-link" href="#extra-features">#</a></h2><p>Docusaurus supports some extra features when writing documentation in markdown.</p><h2><a class="anchor" name="linking-other-documents"></a>Linking other Documents <a class="hash-link" href="#linking-other-documents">#</a></h2><p>You can use relative urls to other documentation files which will automatically get converted to the corresponding html links when they get rendered.</p><p>Example:</p><pre class="prism language-markdown"><span class="token url">[This links to another document](other-document.md)</span></pre><p>This markdown will automatically get converted into a link to <code>/docs/other-document.html</code> (or the appropriately translated/versioned link) once it gets rendered.</p><p>This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct html links when they get rendered.</p><h2><a class="anchor" name="linking-to-images-and-other-assets"></a>Linking to Images and Other Assets <a class="hash-link" href="#linking-to-images-and-other-assets">#</a></h2><p>Static assets can be linked to in the same way that documents are, using relative urls. Static assets used in documents and blogs should go into <code>docs/assets</code> and <code>website/blog/assets</code>, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions.</p><p>Example:</p><pre class="prism language-markdown"><span class="token url"></span></pre><h2><a class="anchor" name="generating-table-of-contents"></a>Generating Table of Contents <a class="hash-link" href="#generating-table-of-contents">#</a></h2><p>You can make an autogenerated list of links, which can be useful as a table of contents for API docs.</p><p>In your markdown file, insert a line with the text <<code>AUTOGENERATED_TABLE_OF_CONTENTS></code>. Write your documentation using <code>h3</code> headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will inserted at the text <<code>AUTOGENERATED_TABLE_OF_CONTENTS></code>.</p><p>Example:</p><pre class="prism language-markdown"><span class="token title important"><span class="token punctuation">###</span> </span><span class="token code keyword">`docusaurus.function(a, b)`</span>
|
||||||
|
|
||||||
|
Text describing my function
|
||||||
|
|
||||||
|
|
||||||
|
<span class="token title important"><span class="token punctuation">###</span> </span><span class="token code keyword">`docdoc(file)`</span>
|
||||||
|
|
||||||
|
Text describing my function</pre><p>will lead to a table of contents of the functions:</p><pre class="prism language-markdown">- <span class="token code keyword">`docusaurus.function(a, b)`</span>
|
||||||
|
- <span class="token code keyword">`docdoc(file)`</span></pre><p>and each function will link to their corresponding sections in the page.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="site-config.html#content">← Previous</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></body></html>
|
||||||
54
docs/getting-started.html
Normal file
54
docs/getting-started.html
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>getting-started · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="getting-started · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## Getting Started"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><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/getting-started.md" target="_blank">Edit this Doc</a><h1>getting-started</h1></header><article><div><h2><a class="anchor" name="getting-started"></a>Getting Started <a class="hash-link" href="#getting-started">#</a></h2><h3><a class="anchor" name="project-structure"></a>Project Structure <a class="hash-link" href="#project-structure">#</a></h3><p>In your project repo, all of your documentation files should be placed inside a <code>docs</code> folder. Any blog posts should be inside a <code>blog</code> folder. Create a <code>website</code> folder inside which you will install and run docusaurus.</p><p>Example project structure:</p><pre class="prism language-javascript">project<span class="token operator">-</span>repo<span class="token operator">/</span>
|
||||||
|
blog<span class="token operator">/</span>
|
||||||
|
<span class="token number">2017</span><span class="token operator">-</span><span class="token number">05</span><span class="token operator">-</span><span class="token number">06</span><span class="token operator">-</span>blog<span class="token operator">-</span>post<span class="token punctuation">.</span>md
|
||||||
|
docs<span class="token operator">/</span>
|
||||||
|
en<span class="token operator">/</span>
|
||||||
|
doc1<span class="token punctuation">.</span>md
|
||||||
|
website<span class="token operator">/</span></pre><h3><a class="anchor" name="installation"></a>Installation <a class="hash-link" href="#installation">#</a></h3><p>Inside of your <code>website</code> folder, create a <code>package.json</code> file with the following scripts for Docusaurus:</p><pre class="prism language-json"><span class="token punctuation">{</span>
|
||||||
|
<span class="token property">"scripts"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"docusaurus-start"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"build"</span><span class="token operator">:</span> <span class="token string">"docusaurus-build"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"publish-gh-pages"</span><span class="token operator">:</span> <span class="token string">"docusaurus-publish"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"examples"</span><span class="token operator">:</span> <span class="token string">"docusaurus-examples"</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">}</span></pre><p>Install Docusaurus using <code>npm</code> or <code>yarn</code>:</p><pre class="prism language-javascript">npm install <span class="token operator">--</span>save<span class="token operator">-</span>dev docusaurus</pre><p>or</p><pre class="prism language-javascript">yarn add docusaurus <span class="token operator">-</span>dev</pre><h2><a class="anchor" name="configuration"></a>Configuration <a class="hash-link" href="#configuration">#</a></h2><h3><a class="anchor" name="generate-examples"></a>Generate Examples <a class="hash-link" href="#generate-examples">#</a></h3><p>To create example files for configuration, run <code>examples</code> using <code>npm</code> or <code>yarn</code>:</p><pre class="prism language-javascript">npm run examples</pre><p>or</p><pre class="prism language-javascript">yarn run examples</pre><p>This will create the following files/folders in your website folder:</p><pre class="prism language-javascript">core<span class="token operator">/</span>Footer<span class="token punctuation">.</span>js
|
||||||
|
pages<span class="token operator">/</span><span class="token operator">...</span>
|
||||||
|
<span class="token keyword">static</span><span class="token regex">/img/</span><span class="token operator">...</span>
|
||||||
|
siteConfig<span class="token punctuation">.</span>js</pre><p>It will also create two folders in the level above the website folder in your project repo:</p><pre class="prism language-javascript">blog<span class="token operator">-</span>examples<span class="token operator">-</span><span class="token keyword">from</span><span class="token operator">-</span>docusaurus
|
||||||
|
docs<span class="token operator">-</span>examples<span class="token operator">-</span><span class="token keyword">from</span><span class="token operator">-</span>docusaurus</pre><p>If any of the files created by <code>yarn run examples</code> already exists, Docusaurus will not overwrite them.</p><p>The provided example files contain configurations for an example site. </p><p>The <code>core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.<br/>The <code>blog-examples-from-docusaurus</code> folder contains examples of blog posts written in markdown.<br/>The <code>docs-examples-from-docusaurus</code> folder contains example documentation files written in markdown.<br/>The <code>pages</code> folder contains example top-level pages for the site.<br/>The <code>static</code> folder contains static assets used by the example site.<br/>The <code>siteConfig.js</code> file is the main configuration file used by Docusaurus. </p><p>You will need to keep the <code>siteConfig.js</code> and <code>core/Footer.js</code> files, but may edit them as you wish.</p><p>You should keep the <code>pages</code> and <code>static</code> folders, but may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>pages</code> and an image to use as your header icon inside <code>static</code>.</p><p>The <code>blog-examples-from-docusaurus</code> and <code>docs-examples-from-docusaurus</code> folders contain example blog and document markdown files. If you wish to run Docusaurus with these files, you need to rename the folders to <code>blog</code> and <code>docs</code>, respectively.</p><h3><a class="anchor" name="how-to-configure-your-site"></a>How to Configure Your Site <a class="hash-link" href="#how-to-configure-your-site">#</a></h3><p>Configure the <code>siteConfig.js</code> file which has comments guiding you through what needs to be done and how each configuration affects your website. You can also refer <a href="/docs/en/site-configuration.md" target="">here</a> for more details.</p><p>Customize <code>core/Footer.js</code> which will serve as the footer for each page on your website.</p><p>Include your own top-level pages as React components in <code>pages</code>:</p><ul><li>These components should just be the body sections of the pages you want, and they will be included with the header and footer that the rest of Docusaurus uses. </li><li>Currently, if you want to add other React components to your pages, you must include all of it inside each <code>.js</code> file in <code>pages</code> due to how <code>require</code> paths are set-up. </li><li>You may also include <code>.html</code> files directly, but this is not recommended, and these will just be served as is and will not have any of the header/footer/styles shared by the rest of Docusaurus.</li><li>Any files in <code>pages/en</code> will also be copied into <code>pages</code> when the server is run and when the site is statically built. i.e. Putting a file in <code>pages/en/index.js</code> will make it available at <code>/en/index.html</code> and <code>/index.html</code>.</li></ul><p>All images and other static assets you wish to include should be placed inside the <code>static</code> folder. Any <code>.css</code> files provided in <code>static</code> will be concatenated to the standard styles provided by Docusaurus and used site-wide.</p><p>A React component placed in <code>website/pages/en/index.js</code> will be available at the url <code>/en/index.html</code>. A static html page placed in <code>website/pages/en/index.html</code> will be available at the url <code>/en/index.html</code>. Provided html files will override provided React components.</p><p>A static asset placed in <code>website/static/img/image.png</code> will be available at the url <code>/img/image.png</code>.</p><p>Example:</p><pre class="prism language-javascript">localhost<span class="token punctuation">:</span><span class="token number">3000</span>$<span class="token punctuation">{</span>baseUrl<span class="token punctuation">}</span>en<span class="token operator">/</span>index<span class="token punctuation">.</span>html
|
||||||
|
localhost<span class="token punctuation">:</span><span class="token number">3000</span>$<span class="token punctuation">{</span>baseUrl<span class="token punctuation">}</span>img<span class="token operator">/</span>image<span class="token punctuation">.</span>png
|
||||||
|
$<span class="token punctuation">{</span>url<span class="token punctuation">}</span>$<span class="token punctuation">{</span>baseUrl<span class="token punctuation">}</span>en<span class="token operator">/</span>index<span class="token punctuation">.</span>html
|
||||||
|
$<span class="token punctuation">{</span>url<span class="token punctuation">}</span>$<span class="token punctuation">{</span>baseUrl<span class="token punctuation">}</span>img<span class="token operator">/</span>image<span class="token punctuation">.</span>png</pre><h3><a class="anchor" name="document-and-blog-front-matters"></a>Document and Blog Front Matters <a class="hash-link" href="#document-and-blog-front-matters">#</a></h3><p>Documentation should contain front matter that follows this example:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
id<span class="token punctuation">:</span> doc1 <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> used <span class="token keyword">for</span> docs to find each other and to map links <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
title<span class="token punctuation">:</span> Document Title
|
||||||
|
layout<span class="token punctuation">:</span> docs1 <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> used to determine different sidebar groupings <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
category<span class="token punctuation">:</span> Sidebar Category <span class="token number">1</span> <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> category on the sidebar under which <span class="token keyword">this</span> doc goes <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
permalink<span class="token punctuation">:</span> docs<span class="token operator">/</span>en<span class="token operator">/</span>doc1<span class="token punctuation">.</span>html <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> link to the document that is used <span class="token keyword">for</span> site <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
previous<span class="token punctuation">:</span> doc0 <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> previous doc on sidebar <span class="token keyword">for</span> navigation <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
next<span class="token punctuation">:</span> doc2 <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> next doc on the sidebar <span class="token keyword">for</span> navigation <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
<span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> don<span class="token string">'t include next if this is the last doc; don'</span>t include previous <span class="token keyword">if</span> first doc <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
<span class="token operator">--</span><span class="token operator">-</span></pre><p>Blog posts should be written as markdown files with the following front matter:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
title<span class="token punctuation">:</span> Blog Post Title
|
||||||
|
author<span class="token punctuation">:</span> Author Name
|
||||||
|
authorURL<span class="token punctuation">:</span> http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>twitter<span class="token punctuation">.</span>com<span class="token operator">/</span>author <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> <span class="token punctuation">(</span>or some other link<span class="token punctuation">)</span> <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
authorFBID<span class="token punctuation">:</span> <span class="token number">21315325</span> <span class="token operator"><</span><span class="token operator">!</span><span class="token operator">--</span> id to <span class="token keyword">get</span> author's picture <span class="token operator">--</span><span class="token operator">></span>
|
||||||
|
<span class="token operator">--</span><span class="token operator">-</span></pre><p>In the blog post you should include a line <code><!--truncate--></code>. This will determine under which point text will be ignored when generating the preview of your blog post. Blog posts should have the file name format: <code>yyyy-mm-dd-your-file-name.md</code>.</p><h2><a class="anchor" name="using-docusaurus"></a>Using Docusaurus <a class="hash-link" href="#using-docusaurus">#</a></h2><h3><a class="anchor" name="run-the-server"></a>Run the Server <a class="hash-link" href="#run-the-server">#</a></h3><p>To run your website locally run the script:</p><pre class="prism language-javascript">npm run start</pre><p>or</p><pre class="prism language-javascript">yarn run start</pre><p>This will start a server hosting your website locally at <code>localhost:3000</code>. Any changes to configured files will be reflected by refreshing the page, i.e. the server does not need to be restarted to show changes. You may also specify a different port to start your server on by using a <code>--port</code> flag:</p><pre class="prism language-javascript">npm run start <span class="token operator">--</span> <span class="token operator">--</span>port <span class="token number">9000</span></pre><h3><a class="anchor" name="build-static-pages"></a>Build Static Pages <a class="hash-link" href="#build-static-pages">#</a></h3><p>To create a static build of your website, run the script:</p><pre class="prism language-javascript">npm run build</pre><p>or</p><pre class="prism language-javascript">yarn run build</pre><p>This will generate <code>.html</code> files from all of your docs and other pages included in <code>pages</code>. This allows you to check whether or not all your files are being generated correctly. The build folder is inside Docusaurus's directory inside <code>node_modules</code>.</p><h3><a class="anchor" name="publishing-your-website"></a>Publishing Your Website <a class="hash-link" href="#publishing-your-website">#</a></h3><p>Use CircleCI to publish your website whenever your project repo is updated. Configure your circle.yml file in your project repo to run commands to publish to GitHub Pages. An example is shown here:</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 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 class="token punctuation">-</span> cd website && npm install && 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>Note that in this case a GitHub user <code>test-site-bot</code> is created to use just for publishing. Make sure to give your Git user push permissions for your project and to set a GITHUB_TOKEN environment variable in Circle if you choose to publish this way.</p><p>If you wish to manually publish your website with the <code>publish-gh-pages</code> script, run the following example command with the appropriate variables for your project:</p><pre class="prism language-javascript">DEPLOY_USER<span class="token operator">=</span>deltice GIT_USER<span class="token operator">=</span>test<span class="token operator">-</span>site<span class="token operator">-</span>bot CIRCLE_PROJECT_USERNAME<span class="token operator">=</span>deltice CIRCLE_PROJECT_REPONAME<span class="token operator">=</span>test<span class="token operator">-</span>site CIRCLE_BRANCH<span class="token operator">=</span>master npm run publish<span class="token operator">-</span>gh<span class="token operator">-</span>pages</pre><h2><a class="anchor" name="more-information"></a>More Information <a class="hash-link" href="#more-information">#</a></h2><p>For details on how to set up translation support, read <a href="translation.md" target="_blank">here</a>.
|
||||||
|
For details on how to set up documentation search, read <a href="search.md" target="_blank">here</a>.</p></div></article></div><div class="docs-prevnext"></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></body></html>
|
||||||
15
docs/installation.html
Normal file
15
docs/installation.html
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Installation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Installation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, follow these steps:"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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>Getting Started</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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/getting-started-installation.md" target="_blank">Edit this Doc</a><h1>Installation</h1></header><article><div><p>Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, follow these steps:</p><ol><li>Create a <code>website</code> folder in the root of your GitHub repo.</li><li><code>cd website</code></li><li><p>Create a <code>package.json</code> file with the following scripts that will be used when developing documentation with Docusaurus:</p><pre class="prism language-json"> <span class="token punctuation">{</span>
|
||||||
|
<span class="token property">"scripts"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"docusaurus-start"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"build"</span><span class="token operator">:</span> <span class="token string">"docusaurus-build"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"publish-gh-pages"</span><span class="token operator">:</span> <span class="token string">"docusaurus-publish"</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token property">"examples"</span><span class="token operator">:</span> <span class="token string">"docusaurus-examples"</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">}</span></pre></li><li><p>Install Docusaurus with <code>yarn</code> or <code>npm</code></p><pre class="prism language-javascript"> yarn add docusaurus <span class="token operator">-</span>dev</pre><p> or</p><pre class="prism language-javascript"> npm install <span class="token operator">--</span>save<span class="token operator">-</span>dev docusaurus</pre></li></ol></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="site-preparation.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></body></html>
|
||||||
48
docs/navigation.html
Normal file
48
docs/navigation.html
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Navigation and Sidebars · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Navigation and Sidebars · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## New Hidden Docs"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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-navigation.md" target="_blank">Edit this Doc</a><h1>Navigation and Sidebars</h1></header><article><div><h2><a class="anchor" name="new-hidden-docs"></a>New Hidden Docs <a class="hash-link" href="#new-hidden-docs">#</a></h2><p>New markdown files within <code>docs</code> will show up as pages on the website. Creating a file such as "docs/getting-started.md" will enable the new page <code>/docs/getting-started.html</code>.</p><p>To change the id (link name) of the file, set the <code>id</code> field in the markdown header. At the top of <code>getting-started.md</code>:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
id<span class="token punctuation">:</span> intro
|
||||||
|
title<span class="token punctuation">:</span> Getting Started
|
||||||
|
<span class="token operator">--</span><span class="token operator">-</span>
|
||||||
|
|
||||||
|
My <span class="token operator">*</span><span class="token keyword">new</span> <span class="token class-name">content</span><span class="token operator">*</span> here<span class="token punctuation">.</span><span class="token punctuation">.</span></pre><p>Now, the doc can be accessed from <code>/docs/intro.html</code>.</p><h2><a class="anchor" name="adding-docs-to-a-sidebar"></a>Adding Docs to a Sidebar <a class="hash-link" href="#adding-docs-to-a-sidebar">#</a></h2><p>Now we want our new page to show up on the sidebar. We configure the order of the sidebar in <code>website/sidebars.json</code>.</p><p>Within <code>sidebars.json</code>, add the doc ID within an existing sidebar/category:</p><pre class="prism language-javascript"><span class="token punctuation">{</span>
|
||||||
|
<span class="token string">"docs"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token string">"Getting Started"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token string">"getting-started"</span></pre><p>Or you can create a new category within the sidebar:</p><pre class="prism language-javascript"><span class="token punctuation">{</span>
|
||||||
|
<span class="token string">"docs"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token string">"My New Sidebar Category"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token string">"getting-started"</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span></pre><h2><a class="anchor" name="new-hidden-sections"></a>New Hidden Sections <a class="hash-link" href="#new-hidden-sections">#</a></h2><p>You can also put the doc in a new sidebar. In this case we are creating a <code>intro</code> section within <code>sidebars.json</code>.</p><pre class="prism language-javascript"><span class="token punctuation">{</span>
|
||||||
|
<span class="token string">"intro"</span><span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token string">"My Sidebar Category"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token string">"getting-started"</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span></pre><p>Keep in mind, until you add the section to the nav bar (below), this new "intro" section of the site will be hidden with no links going to it.</p><h2><a class="anchor" name="adding-doc-to-site-nav-bar"></a>Adding doc to site nav bar <a class="hash-link" href="#adding-doc-to-site-nav-bar">#</a></h2><p>After creating a new section of the site by adding to <code>sidebars.json</code>, you can link to the new doc from the top navigation bar by editing the <code>headerLinks</code> field of <code>siteConfig.js</code>.</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">'intro'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Getting Started'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><h2><a class="anchor" name="custom-page-links-in-nav-bar"></a>Custom page links in nav bar <a class="hash-link" href="#custom-page-links-in-nav-bar">#</a></h2><p>To add custom pages to the navigation bar, entries can be added to the <code>headerLinks</code> of <code>siteConfig.js</code>. For example, if we have a page within <code>website/pages/help.js</code>, we can link to it by adding the following:</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">{</span> page<span class="token punctuation">:</span> <span class="token string">'help'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Help'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><h2><a class="anchor" name="external-links-in-nav-bar"></a>External links in nav bar <a class="hash-link" href="#external-links-in-nav-bar">#</a></h2><p>Custom links can be added to the nav bar with the following entry in <code>siteConfig.js</code>:</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">{</span> href<span class="token punctuation">:</span> <span class="token string">'https://github.com/facebookexperimental/Docusaurus'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'GitHub'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><p>To open external links in a new tab, provide an <code>external: true</code> flag within the header link config.</p><h2><a class="anchor" name="search-bar-position-in-nav-bar"></a>Search bar position in nav bar <a class="hash-link" href="#search-bar-position-in-nav-bar">#</a></h2><p>If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the <code>headerLinks</code> config array:</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">'foo'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Foo'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<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 class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">'bar'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Bar'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre><h2><a class="anchor" name="languages-dropdown-position-in-nav-bar"></a>Languages dropdown position in nav bar <a class="hash-link" href="#languages-dropdown-position-in-nav-bar">#</a></h2><p>If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the <code>headerLinks</code> config array:</p><pre class="prism language-javascript">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">'foo'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Foo'</span> <span class="token punctuation">}</span><span class="token punctuation">,</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> doc<span class="token punctuation">:</span> <span class="token string">'bar'</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Bar'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span></pre></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="custom-pages.html#content">← Previous</a><a class="docs-next button" href="blog.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></body></html>
|
||||||
31
docs/search.html
Normal file
31
docs/search.html
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Enabling Search · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Enabling Search · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus supports search using [Algolia DocSearch](https://community.algolia.com/docsearch/). Once you have set up your site, [enter your site information](https://community.algolia.com/docsearch/) to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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-search.md" target="_blank">Edit this Doc</a><h1>Enabling Search</h1></header><article><div><p>Docusaurus supports search using <a href="https://community.algolia.com/docsearch/" target="_blank">Algolia DocSearch</a>. Once you have set up your site, <a href="https://community.algolia.com/docsearch/" target="_blank">enter your site information</a> to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.</p><h3><a class="anchor" name="enabling-the-search-bar"></a>Enabling the Search Bar <a class="hash-link" href="#enabling-the-search-bar">#</a></h3><p>Enter your search-only API key and index name into <code>siteConfig.js</code> in the <code>algolia</code> section to enable search for your site.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
algolia<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
apiKey<span class="token punctuation">:</span> <span class="token string">"my-search-only-api-key-1234"</span><span class="token punctuation">,</span>
|
||||||
|
indexName<span class="token punctuation">:</span> <span class="token string">"my-index-name"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="extra-search-options"></a>Extra Search Options <a class="hash-link" href="#extra-search-options">#</a></h3><p>You can also specify extra <a href="https://community.algolia.com/docsearch/documentation/" target="_blank">search options used by Algolia</a> by using an <code>algoliaOptions</code> field in <code>algolia</code>. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be <a href="https://www.algolia.com/doc/api-reference/api-parameters/#overview" target="_blank">found here</a>.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
algolia<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
algoliaOptions<span class="token punctuation">:</span> <span class="token string">'{ facetFilters: [ "tags:VERSION" ], hitsPerPage: 5 }'</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="controlling-the-location-of-the-search-bar"></a>Controlling the Location of the Search Bar <a class="hash-link" href="#controlling-the-location-of-the-search-bar">#</a></h3><p>By default, the search bar will be the rightmost element in the top navigation bar.</p><p>If you want to change the default location, add the <code>searchBar</code> flag in the <code>headerLinks</code> field of <code>siteConfig.js</code> in your desired location. For example, you may want the search bar in between your internal and external links.</p><pre class="prism language-js"><span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||||
|
<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 class="token operator">...</span><span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">{</span><span class="token operator">...</span><span class="token punctuation">}</span>
|
||||||
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token operator">...</span>
|
||||||
|
<span class="token punctuation">}</span></pre><h3><a class="anchor" name="disabling-the-search-bar"></a>Disabling the Search Bar <a class="hash-link" href="#disabling-the-search-bar">#</a></h3><p>To disable the search bar, comment out (recommended) or delete the <code>algolia</code> section in the <code>siteConfig.js</code> file.</p><p>Also, if you have customized the location of the search bar in <code>headerLinks</code>, set <code>search: false</code>.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="translation.html#content">← Previous</a><a class="docs-next button" href="versioning.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></body></html>
|
||||||
71
docs/site-config.html
Normal file
71
docs/site-config.html
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
<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/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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/api-site-config.md" target="_blank">Edit this Doc</a><h1>siteConfig.js</h1></header><article><div><p>A large part of site configuration is done by editing the <code>siteConfig.js</code> file.</p><h2><a class="anchor" name="user-showcase"></a>User Showcase <a class="hash-link" href="#user-showcase">#</a></h2><p>The <code>users</code> array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the <code>pages/en/index.js</code> and <code>pages/en/users.js</code> files provided. Each user object should have <code>caption</code>, <code>image</code>, <code>infoLink</code>, and <code>pinned</code> fields. The <code>caption</code> is the text showed when someone hovers over the <code>image</code> of that user, and the <code>infoLink</code> is where clicking the image will bring someon. The <code>pinned</code> field determines whether or not it shows up on the <code>index</code> page.</p><p>Currently this <code>users</code> array is used only by the <code>index.js</code> and <code>users.js</code> example files. If you do not wish to have a users page or show users on the <code>index</code> page, you may remove this section.</p><h2><a class="anchor" name="siteconfig-fields"></a>siteConfig Fields <a class="hash-link" href="#siteconfig-fields">#</a></h2><p>The <code>siteConfig</code> object contains the bulk of the configuration settings for your website.</p><h3><a class="anchor" name="mandatory-fields"></a>Mandatory Fields <a class="hash-link" href="#mandatory-fields">#</a></h3><p><code>title</code> - Title for your website.</p><p><code>tagline</code> - Tagline for your website. </p><p><code>url</code> - url for your site.</p><p><code>baseUrl</code> - baseUrl for your site.</p><p><code>projectName</code> - Project name.</p><p><code>headerLinks</code> - Links that will be used in the header navigation bar. The <code>label</code> field of each object will be the link text and will also be translated for each language.</p><p>Example Usage:</p><pre class="prism language-js">headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span spellcheck="true" class="token comment">// Links to document with id doc1 for current language/version</span>
|
||||||
|
<span class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">"doc1"</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"Getting Started"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language</span>
|
||||||
|
<span class="token punctuation">{</span> page<span class="token punctuation">:</span> <span class="token string">"help"</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"Help"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// Links to href destination</span>
|
||||||
|
<span class="token punctuation">{</span> href<span class="token punctuation">:</span> <span class="token string">"https://github.com/"</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"GitHub"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// Links to blog generated by Docusaurus (${baseUrl}blog)</span>
|
||||||
|
<span class="token punctuation">{</span> blog<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"Blog"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// Determines search bar position among links</span>
|
||||||
|
<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>
|
||||||
|
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>
|
||||||
|
infoLink<span class="token punctuation">:</span> <span class="token string">"https://www.example.com"</span><span class="token punctuation">,</span>
|
||||||
|
pinned<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>
|
||||||
|
|
||||||
|
<span class="token keyword">const</span> siteConfig <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||||
|
title<span class="token punctuation">:</span> <span class="token string">"Docusaurus"</span><span class="token punctuation">,</span>
|
||||||
|
tagline<span class="token punctuation">:</span> <span class="token string">"Generate websites!"</span><span class="token punctuation">,</span>
|
||||||
|
url<span class="token punctuation">:</span> <span class="token string">"https://deltice.github.io"</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// url: "https://www.example.com",</span>
|
||||||
|
baseUrl<span class="token punctuation">:</span> <span class="token string">"/test-site/"</span><span class="token punctuation">,</span>
|
||||||
|
<span spellcheck="true" class="token comment">// baseUrl: "/",</span>
|
||||||
|
projectName<span class="token punctuation">:</span> <span class="token string">"docusaurus"</span><span class="token punctuation">,</span>
|
||||||
|
headerLinks<span class="token punctuation">:</span> <span class="token punctuation">[</span>
|
||||||
|
<span class="token punctuation">{</span> doc<span class="token punctuation">:</span> <span class="token string">"doc1"</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"Docs"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<span class="token punctuation">{</span> page<span class="token punctuation">:</span> <span class="token string">"help"</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">"Help"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
<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 class="token punctuation">{</span> blog<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>
|
||||||
|
<span spellcheck="true" class="token comment">// headerLinks: [],</span>
|
||||||
|
headerIcon<span class="token punctuation">:</span> <span class="token string">"img/docusaurus.svg"</span><span class="token punctuation">,</span>
|
||||||
|
favicon<span class="token punctuation">:</span> <span class="token string">"img/favicon.png"</span><span class="token punctuation">,</span>
|
||||||
|
colors<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
primaryColor<span class="token punctuation">:</span> <span class="token string">"#2E8555"</span><span class="token punctuation">,</span>
|
||||||
|
secondaryColor<span class="token punctuation">:</span> <span class="token string">"#205C3B"</span><span class="token punctuation">,</span>
|
||||||
|
prismColor<span class="token punctuation">:</span>
|
||||||
|
<span class="token string">"rgba(46, 133, 85, 0.03)"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
|
||||||
|
|
||||||
|
editUrl<span class="token punctuation">:</span> <span class="token string">"https://github.com/deltice/test-site/edit/master/docs/"</span><span class="token punctuation">,</span>
|
||||||
|
users<span class="token punctuation">,</span>
|
||||||
|
disableHeaderTitle<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||||||
|
disableTitleTagline<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span>
|
||||||
|
separateCss<span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"static/css/non-docusaurus"</span><span class="token punctuation">,</span> <span class="token string">"static/assets/separate-css"</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
|
||||||
|
footerIcon<span class="token punctuation">:</span> <span class="token string">"img/docusaurus.svg"</span><span class="token punctuation">,</span>
|
||||||
|
recruitingLink<span class="token punctuation">:</span>
|
||||||
|
<span class="token string">"https://crowdin.com/project/docusaurus"</span><span class="token punctuation">,</span>
|
||||||
|
algolia<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
||||||
|
apiKey<span class="token punctuation">:</span>
|
||||||
|
<span class="token string">"0f9f28b9ab9efae89810921a351753b5"</span><span class="token punctuation">,</span>
|
||||||
|
indexName<span class="token punctuation">:</span> <span class="token string">"github"</span>
|
||||||
|
<span class="token punctuation">}</span>
|
||||||
|
gaTrackingId<span class="token punctuation">:</span> <span class="token string">"U-A2352"</span>
|
||||||
|
<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></body></html>
|
||||||
15
docs/site-creation.html
Normal file
15
docs/site-creation.html
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Creating your site · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Creating your site · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus' primary purpose of existence is to make it super simple for you to create documentation for your project and have a site to house those docs."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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>Getting Started</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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/getting-started-site-creation.md" target="_blank">Edit this Doc</a><h1>Creating your site</h1></header><article><div><p>Docusaurus' primary purpose of existence is to make it super simple for you to create documentation for your project and have a site to house those docs.</p><p>After <a href="/docs/installation.html" target="">installation</a> and <a href="/docs/site-preparation.html" target="">preparation</a>, much of the work to create a basic site for your docs is already complete.</p><h2><a class="anchor" name="load-the-example-site"></a>Load the Example Site <a class="hash-link" href="#load-the-example-site">#</a></h2><p><a href="/docs/site-preparation.html" target="">Preparation</a> created a sample site for you to see Docusaurus in action. However, it also provided the infrastructure that will be used as you are developing your own site.</p><h2><a class="anchor" name="site-structure"></a>Site Structure <a class="hash-link" href="#site-structure">#</a></h2><p>After loading the example site, you should see a structure in your repo that looks similar to:</p><pre class="prism language-javascript">project<span class="token operator">-</span>repo<span class="token operator">/</span>
|
||||||
|
docs<span class="token operator">/</span>
|
||||||
|
doc1<span class="token punctuation">.</span>md
|
||||||
|
website<span class="token operator">/</span>
|
||||||
|
blog<span class="token operator">/</span>
|
||||||
|
<span class="token number">2017</span><span class="token operator">-</span><span class="token number">05</span><span class="token operator">-</span><span class="token number">06</span><span class="token operator">-</span>blog<span class="token operator">-</span>post<span class="token punctuation">.</span>md</pre><p>All of your documentation files should be placed inside the <code>docs</code> folder as markdown <code>.md</code> files. Any blog posts should be inside the <code>blog</code> folder.</p><blockquote><p>The blog posts must be formatted as yyyy-mm-dd-your-file-name.md</p></blockquote><h2><a class="anchor" name="create-your-basic-site"></a>Create Your Basic Site <a class="hash-link" href="#create-your-basic-site">#</a></h2><p>To create a fully functional site, you only need to do a few steps:</p><ol><li>Add your documentation to the <code>/docs</code> folder as <code>.md</code> files, ensuring you have the proper <a href="/docs/doc-markdown.html" target="">header</a> in each file.</li><li><p>Add zero or more docs to the <a href="/docs/navigation.html" target=""><code>sidebars.json</code></a> file so that your documentation is rendered in a sidebar, if you choose them to be.</p><blockquote><p>If you do not add your documentation to the <code>sidebars.json</code> file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.</p></blockquote></li><li><p>Modify the <code>website/siteConfig.js</code> file to <a href="/docs/site-config.html" target="">configure your site</a>, following the comments included in that file to guide you.</p></li><li><a href="/docs/custom-pages.html" target="">Customize</a> the <code>website/core/Footer.js</code> file that provides the footer for your site.</li><li>Place assets, such as images, in the <code>website/static/</code> folder.</li><li><p>Run the site to see the results of your changes. </p><pre class="prism language-javascript">cd website
|
||||||
|
yarn run start # or <span class="token operator">-</span> npm run start
|
||||||
|
# navigate to http<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>localhost<span class="token punctuation">:</span><span class="token number">3000</span></pre></li></ol></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="site-preparation.html#content">← Previous</a><a class="docs-next button" href="custom-pages.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></body></html>
|
||||||
13
docs/site-preparation.html
Normal file
13
docs/site-preparation.html
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="After [installing Docusaurus](/docs/installation.html), you will want to install and run the example site included. This serves dual purposes."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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>Getting Started</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/installation.html#content">Installation</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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/getting-started-preparation.md" target="_blank">Edit this Doc</a><h1>Site Preparation</h1></header><article><div><p>After <a href="/docs/installation.html" target="">installing Docusaurus</a>, you will want to install and run the example site included. This serves dual purposes.</p><ol><li>Verifying that Docusaurus was installed correctly.</li><li>Providing you the skeleton to create your site.</li></ol><h2><a class="anchor" name="verifying-installation"></a>Verifying Installation <a class="hash-link" href="#verifying-installation">#</a></h2><ol><li><p>Generate the files for the example site by running <code>examples</code> using <code>yarn</code> or <code>npm</code>.</p><pre class="prism language-javascript"> npm run examples</pre><p> or</p><pre class="prism language-javascript"> yarn run examples</pre><blockquote><p>If any of the files created by <code>[yarn | npm] run examples</code> already exists, Docusaurus will not overwrite them.</p></blockquote></li><li><p>Run the server.</p><pre class="prism language-javascript"> npm run start</pre><p> or</p><pre class="prism language-javascript"> yarn run start</pre></li><li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a>. You should see the example site loaded in your web browser.</p></li></ol><h2><a class="anchor" name="example-site-configuration"></a>Example Site Configuration <a class="hash-link" href="#example-site-configuration">#</a></h2><p>Loading the example site will create the following files/folders:</p><pre class="prism language-javascript">website<span class="token operator">/</span>core<span class="token operator">/</span>Footer<span class="token punctuation">.</span>js
|
||||||
|
website<span class="token regex">/pages/</span><span class="token operator">...</span>
|
||||||
|
website<span class="token operator">/</span><span class="token keyword">static</span><span class="token regex">/img/</span><span class="token operator">...</span>
|
||||||
|
website<span class="token operator">/</span>siteConfig<span class="token punctuation">.</span>js
|
||||||
|
website<span class="token regex">/blog-examples-from-docusaurus/</span><span class="token operator">...</span>
|
||||||
|
docs<span class="token operator">-</span>examples<span class="token operator">-</span><span class="token keyword">from</span><span class="token operator">-</span>docusaurus<span class="token operator">/</span><span class="token operator">...</span></pre><blockquote><p>The <code>docs-examples-from-docusaurus</code> folder will be at the same directory level as <code>website</code>, not in it.</p></blockquote><p>The provided example files contain configurations that can be used as starting points for your site:</p><ul><li>The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li><li>The <code>website/blog-examples-from-docusaurus</code> folder contains examples of blog posts written in markdown.</li><li>The <code>docs-examples-from-docusaurus</code> folder contains example documentation files written in markdown.</li><li>The <code>website/pages</code> folder contains example top-level pages for the site.</li><li>The <code>website/static</code> folder contains static assets used by the example site.</li><li>The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li></ul><p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish.</p><p>You should keep the <code>website/pages</code> and <code>website/static</code> folders, but may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p><p>The <code>website/blog-examples-from-docusaurus</code> and <code>docs-examples-from-docusaurus</code> folders contain example blog and document markdown files. If you wish to run Docusaurus with these files, you need to rename the folders to <code>website/blog</code> and <code>docs</code>, respectively.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="installation.html#content">← Previous</a><a class="docs-next button" href="site-creation.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></body></html>
|
||||||
55
docs/translation.html
Normal file
55
docs/translation.html
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Translations · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Translations · 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. 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/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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</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. 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>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 is the same example help page generated by the <code>examples</code> script but now using translations tags that are described below.
|
||||||
|
The <code>languages.js</code> file tells Docusaurus what languages you want to enable for your site.
|
||||||
|
The <code>crowdin.yaml</code> file is used to configure crowdin integration, and is copied out one level into your project repo.</p><h2><a class="anchor" name="writing-pages-to-be-translated"></a>Writing Pages to be Translated <a class="hash-link" href="#writing-pages-to-be-translated">#</a></h2><p>Any pages with text you want to be translated should go into the <code>website/pages/en</code> folder. Simply wrap any 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 is a Header I want 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><p>Documentation files do not need to be changed to support translations. They will be uploaded to Crowdin to be translated directly.</p><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>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 uses <a href="https://crowdin.com/" target="_blank">Crowdin</a> to manage translations and then downloads appropriately translated files from Crowdin. More information on how to set up Crowdin translations later.</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 some more context for how translation works, but is not necessary information for the user to know.</p><p>For things like the strings found in the headers and sidebars of pages, Docusaurus references a translated version of <code>i18n/en.json</code> (for example, a <code>i18n/fr.json</code> file downloaded from Crowdin).</p><p>For documentation text itself, fully translated markdown files will be compiled in the same way English documentation markdown files would be.</p><p>For other pages, Docusaurus will automatically transform all <code><translate></code> tags into function calls that will return appropriately translated strings. For each language that is enabled with <code>languages.js</code>, Docusaurus will build translated pages using the files in <code>pages/en</code> and the language's respective <code>.json</code> file in <code>i18n</code>.</p><h2><a class="anchor" name="crowdin-set-up"></a>Crowdin Set-Up <a class="hash-link" href="#crowdin-set-up">#</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><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="translations-and-versioning"></a>Translations and Versioning <a class="hash-link" href="#translations-and-versioning">#</a></h2><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">Copyright © 2017 Facebook Inc.</section></footer></div></body></html>
|
||||||
16
docs/versioning.html
Normal file
16
docs/versioning.html
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Versioning · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Versioning · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Users can use the `version` script to cut a new documentation version based on the latest content in the `docs` folder. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` folder changes moving forward."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.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 src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></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/installation.html#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/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/custom-pages.html#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/translation.html#content">Translations</a></li><li class="navListItem"><a class="navItem" href="/docs/search.html#content">Enabling Search</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/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-versioning.md" target="_blank">Edit this Doc</a><h1>Versioning</h1></header><article><div><p>Users can use the <code>version</code> script to cut a new documentation version based on the latest content in the <code>docs</code> folder. That specific set of documentation will then be preserved and accessible even as the documentation in the <code>docs</code> folder changes moving forward.</p><h2><a class="anchor" name="how-to-create-new-versions"></a>How to Create New Versions <a class="hash-link" href="#how-to-create-new-versions">#</a></h2><p>Add the following script to your <code>package.json</code> 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">"version"</span><span class="token operator">:</span> <span class="token string">"docusaurus-version"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
...</pre><p>Run the script with a command line argument of the version you wish to create. e.g.,</p><pre class="prism language-bash"><span class="token function">npm</span> run version 1.0.0</pre><p>This will preserve all documents currently in the <code>docs</code> folder and make them available as documentation for version <code>1.0.0</code>.</p><p>If, for example, you ran the version script with 1.0.0 as the version number, version 1.0.0 is considered the latest release version for your project, and the site will display the version number next to the title in the header.</p><p>Documents in the <code>docs</code> folder will be considered part of version <code>next</code> and they are available, for example, at the url <code>docs/next/doc1.html</code>. Documents from the latest version use the url <code>docs/doc1.html</code>.</p><p>Running the script again with <code>npm run version 2.0.0</code> will create a version <code>2.0.0</code>, making version 2.0.0 the most recent set of documentation. Documents from version <code>1.0.0</code> will use the url <code>docs/1.0.0/doc1.html</code> while <code>2.0.0</code> will use <code>docs/doc1.html</code>.</p><h2><a class="anchor" name="versioning-patterns"></a>Versioning Patterns <a class="hash-link" href="#versioning-patterns">#</a></h2><p>Users can create version numbers in whatever format they wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.</p><h2><a class="anchor" name="storing-files-for-each-version"></a>Storing Files for Each Version <a class="hash-link" href="#storing-files-for-each-version">#</a></h2><p>Versioned documents are placed into <code>website/versioned_docs/version-${version}</code>, where <code>${version}</code> is the version number you supplied the <code>version</code> script. </p><p>The markdown header for each versioned doc is altered by appending <code>"version-${version}-"</code> to the id and by adding an <code>original_id</code> field.</p><p>Versioned sidebars are copied into <code>website/versioned_sidebars</code> and are named as <code>version-${version}-sidebar.json</code>. </p><p>A <code>website/versions.json</code> file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the <code>versions.json</code> file. </p><p>If you wish to change the documentation for a past version, you can access the files for that respective version. </p><h2><a class="anchor" name="fallback-functionality"></a>Fallback Functionality <a class="hash-link" href="#fallback-functionality">#</a></h2><p>Only files in the <code>docs</code> folder 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> folder. 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><h2><a class="anchor" name="renaming-existing-versions"></a>Renaming Existing Versions <a class="hash-link" href="#renaming-existing-versions">#</a></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 class="prism language-json">...
|
||||||
|
<span class="token property">"scripts"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
||||||
|
<span class="token property">"rename-version"</span><span class="token operator">:</span> <span class="token string">"docusaurus-rename-version"</span>
|
||||||
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||||
|
...</pre><p>Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,</p><pre class="prism language-bash"><span class="token function">npm</span> run rename-version 1.0.0 1.0.1</pre><h2><a class="anchor" name="versioning-and-translations"></a>Versioning and Translations <a class="hash-link" href="#versioning-and-translations">#</a></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 folder <code>translated_docs/${language}/version-${version}/</code>. For more information, check out the <a href="translation.md" target="_blank">translations guide</a>.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="search.html#content">← Previous</a><a class="docs-next button" href="commands.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></body></html>
|
||||||
2
en/help.html
Normal file
2
en/help.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h2>Need help?</h2></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Browse Docs</p></div></h2><div><p>Learn more using the <a href="/docs/installation.html" target="">documentation on this site</a>.</p></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Join the community</p></div></h2><div><p>Submit issues and pull requests for any new features you may want to see or bugs you've found on <a href="https://github.com/facebookexperimental/docusaurus" target="_blank">GitHub</a>.</p></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Stay up to date</p></div></h2><div><p>Find out what's new with this project by checking back on the site.</p></div></div></div></div></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></body></html>
|
||||||
4
en/index.html
Normal file
4
en/index.html
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div><div class="homeContainer"><div class="homeSplashFade"><div class="wrapper homeWrapper"><div class="projectLogo"><img src="/img/docusaurus_keytar.svg"/></div><div class="inner"><h2 class="projectTitle">Docusaurus<small>Open Source Documentation Websites</small></h2><div class="section promoSection"><div class="promoRow"><div class="pluginRowBlock"><div class="pluginWrapper buttonWrapper"><a class="button" href="
|
||||||
|
/docs/installation.html
|
||||||
|
" target="_self">Get Started</a></div></div></div></div></div></div></div></div><div class="mainContainer"><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/markdown.png"/></div><div class="blockContent"><h2><div><p>Powered by Markdown</p></div></h2><div><p>Save time and focus on your project's documentation. Simply write docs and blog posts with Markdown and Docusaurus will publish a set of static html files ready to serve.</p></div></div></div><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/react.svg"/></div><div class="blockContent"><h2><div><p>Built Using React</p></div></h2><div><p>Extend or customize your project's layout by reusing React. Docusaurus can be extended while reusing the same header and footer.</p></div></div></div><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/translation.svg"/></div><div class="blockContent"><h2><div><p>Ready for Translations</p></div></h2><div><p>Localization comes pre-configured. Use Crowdin to translate your docs into over 70 languages.</p></div></div></div></div><br/><br/><div class="gridBlock"><div class="blockElement alignCenter imageAlignTop twoByGridBlock"><div class="blockImage"><img src="/img/versioning.svg"/></div><div class="blockContent"><h2><div><p>Document Versioning</p></div></h2><div><p>Support users on all versions of your project. Document Versioning helps you keep documentation in sync with project releases.</p></div></div></div><div class="blockElement alignCenter imageAlignTop twoByGridBlock"><div class="blockImage"><img src="/img/search.svg"/></div><div class="blockContent"><h2><div><p>Document Search</p></div></h2><div><p>Make it easy for your community to find what they need in your documentation. Currently supports Algolia DocSearch.</p></div></div></div></div></div></div><div class="container lightBackground paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockContent"><h2><div><p>Quick Setup</p></div></h2><div><p>Get up and running quickly without having having to worry about site design.</p></div></div><div class="blockImage"><img src="/img/docusaurus_speed.svg"/></div></div></div></div></div><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockImage"><img src="/img/docusaurus_live.gif"/></div><div class="blockContent"><h2><div><p>Develop and Deploy</p></div></h2><div><p>Make design and documentation changes by using the included live server. Publish your site to GitHub pages or other static file hosts manually, using a script, or with continuous integration like CircleCI.</p></div></div></div></div></div></div><div class="container lightBackground paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockContent"><h2><div><p>Website Features</p></div></h2><div><p>Docusaurus currently provides support to help your website use <a href="/docs/translation.html" target="">translations</a>, <a href="/docs/search.html" target="">search</a>, and <a href="/docs/versioning.html" target="">versioning</a>, along with some other special <a href="/docs/doc-markdown.html" target="">documentation markdown features</a>. If you have ideas for useful features, feel free to contribute on <a href="https://github.com/facebookexperimental/docusaurus" target="_blank">GitHub</a>!</p></div></div><div class="blockImage"><img src="/img/docusaurus_monochrome.svg"/></div></div></div></div></div><div class="productShowcaseSection paddingBottom"><h2>Who's Using This?</h2><p>Docusaurus is building websites for these projects</p><div class="logos"><a href="https://www.prettier.io"><img src="/img/prettier.png" title="Prettier"/></a><a href="https://fasttext.cc"><img src="/img/fasttext.png" title="FastText"/></a><a href="https://www.docusaurus.io"><img src="/img/docusaurus.svg" title="Docusaurus"/></a></div><div class="more-users"><a class="button" href="/en/users.html">All Docusaurus Users</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></body></html>
|
||||||
2
en/users.html
Normal file
2
en/users.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="mainContainer"><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="showcaseSection"><div class="prose"><h1>Who's Using This?</h1><p>This project is used by many folks</p></div><div class="logos"><a href="https://www.prettier.io"><img src="/img/prettier.png" title="Prettier"/></a><a href="https://fasttext.cc"><img src="/img/fasttext.png" title="FastText"/></a><a href="https://www.docusaurus.io"><img src="/img/docusaurus.svg" title="Docusaurus"/></a></div><p>Are you using this project?</p><a href="https://github.com/facebookexperimental/docusaurus/edit/master/website/siteConfig.js" class="button">Add your project</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></body></html>
|
||||||
2
help.html
Normal file
2
help.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h2>Need help?</h2></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Browse Docs</p></div></h2><div><p>Learn more using the <a href="/docs/installation.html" target="">documentation on this site</a>.</p></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Join the community</p></div></h2><div><p>Submit issues and pull requests for any new features you may want to see or bugs you've found on <a href="https://github.com/facebookexperimental/docusaurus" target="_blank">GitHub</a>.</p></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><p>Stay up to date</p></div></h2><div><p>Find out what's new with this project by checking back on the site.</p></div></div></div></div></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></body></html>
|
||||||
35
img/docusaurus.svg
Normal file
35
img/docusaurus.svg
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="200px" height="200px" viewBox="0 0 200 200" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
|
||||||
|
<title>docusaurus</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs></defs>
|
||||||
|
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<g id="docusaurus">
|
||||||
|
<rect id="Rectangle" fill="#FFFFFF" x="99" y="52" width="84" height="34"></rect>
|
||||||
|
<g id="Group-2" transform="translate(3.000000, 17.000000)">
|
||||||
|
<path d="M20,146 C12.602,146 6.157,141.973 2.697,136 C0.992,138.944 0,142.353 0,146 C0,157.046 8.954,166 20,166 L40,166 L40,146 L20,146 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<path d="M109.9805,40.376 L180.0005,36 L180.0005,26 C180.0005,14.954 171.0455,6 160.0005,6 L70.0005,6 L67.5005,1.67 C66.3885,-0.255 63.6115,-0.255 62.5005,1.67 L60.0005,6 L57.5005,1.67 C56.3885,-0.255 53.6115,-0.255 52.5005,1.67 L50.0005,6 L47.5005,1.67 C46.3885,-0.255 43.6115,-0.255 42.5005,1.67 L40.0005,6 C39.9785,6 39.9575,6.003 39.9355,6.003 L35.7935,1.862 C34.2225,0.291 31.5405,1.009 30.9645,3.156 L29.5965,8.26 L24.4035,6.868 C22.2565,6.293 20.2925,8.257 20.8685,10.404 L22.2595,15.597 L17.1565,16.964 C15.0095,17.54 14.2905,20.223 15.8615,21.794 L20.0025,25.936 C20.0025,25.957 20.0005,25.978 20.0005,26 L15.6695,28.5 C13.7455,29.611 13.7455,32.389 15.6695,33.5 L20.0005,36 L15.6695,38.5 C13.7455,39.611 13.7455,42.389 15.6695,43.5 L20.0005,46 L15.6695,48.5 C13.7455,49.611 13.7455,52.389 15.6695,53.5 L20.0005,56 L15.6695,58.5 C13.7455,59.611 13.7455,62.389 15.6695,63.5 L20.0005,66 L15.6695,68.5 C13.7455,69.611 13.7455,72.389 15.6695,73.5 L20.0005,76 L15.6695,78.5 C13.7455,79.611 13.7455,82.389 15.6695,83.5 L20.0005,86 L15.6695,88.5 C13.7455,89.611 13.7455,92.389 15.6695,93.5 L20.0005,96 L15.6695,98.5 C13.7455,99.611 13.7455,102.389 15.6695,103.5 L20.0005,106 L15.6695,108.5 C13.7455,109.611 13.7455,112.389 15.6695,113.5 L20.0005,116 L15.6695,118.5 C13.7455,119.611 13.7455,122.389 15.6695,123.5 L20.0005,126 L15.6695,128.5 C13.7455,129.611 13.7455,132.389 15.6695,133.5 L20.0005,136 L15.6695,138.5 C13.7455,139.611 13.7455,142.389 15.6695,143.5 L20.0005,146 C20.0005,157.046 28.9545,166 40.0005,166 L160.0005,166 C171.0455,166 180.0005,157.046 180.0005,146 L180.0005,66 L109.9805,61.624 C104.3705,61.273 100.0005,56.621 100.0005,51 C100.0005,45.379 104.3705,40.727 109.9805,40.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-5" fill="#3ECC5F" points="140 166 170 166 170 126 140 126"></polygon>
|
||||||
|
<path d="M190,141 C189.781,141 189.572,141.037 189.361,141.064 C189.323,140.914 189.287,140.763 189.245,140.613 C191.051,139.859 192.32,138.079 192.32,136 C192.32,133.238 190.082,131 187.32,131 C186.182,131 185.145,131.396 184.304,132.036 C184.193,131.923 184.082,131.811 183.969,131.7 C184.596,130.864 184.98,129.838 184.98,128.713 C184.98,125.951 182.742,123.713 179.98,123.713 C177.915,123.713 176.143,124.966 175.381,126.754 C175.233,126.712 175.084,126.677 174.936,126.639 C174.963,126.428 175,126.219 175,126 C175,123.238 172.762,121 170,121 C167.238,121 165,123.238 165,126 C165,126.219 165.037,126.428 165.064,126.639 C164.916,126.677 164.767,126.712 164.619,126.754 C163.857,124.966 162.085,123.713 160.02,123.713 C157.258,123.713 155.02,125.951 155.02,128.713 C155.02,129.838 155.404,130.864 156.031,131.7 C152.314,135.332 150,140.393 150,146 C150,157.046 158.954,166 170,166 C179.339,166 187.16,159.59 189.361,150.936 C189.572,150.963 189.781,151 190,151 C192.762,151 195,148.762 195,146 C195,143.238 192.762,141 190,141" id="Fill-7" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-8" fill="#3ECC5F" points="150 106 180 106 180 86 150 86"></polygon>
|
||||||
|
<path d="M190,98.5 C191.381,98.5 192.5,97.381 192.5,96 C192.5,94.619 191.381,93.5 190,93.5 C189.891,93.5 189.786,93.519 189.681,93.532 C189.661,93.457 189.644,93.382 189.623,93.307 C190.525,92.93 191.16,92.039 191.16,91 C191.16,89.619 190.041,88.5 188.66,88.5 C188.091,88.5 187.572,88.697 187.152,89.018 C187.097,88.961 187.041,88.905 186.984,88.85 C187.298,88.433 187.49,87.919 187.49,87.356 C187.49,85.976 186.371,84.856 184.99,84.856 C183.957,84.856 183.071,85.483 182.69,86.377 C181.833,86.138 180.934,86 180,86 C174.478,86 170,90.478 170,96 C170,101.522 174.478,106 180,106 C180.934,106 181.833,105.862 182.69,105.623 C183.071,106.517 183.957,107.144 184.99,107.144 C186.371,107.144 187.49,106.024 187.49,104.644 C187.49,104.081 187.298,103.567 186.984,103.15 C187.041,103.095 187.097,103.039 187.152,102.982 C187.572,103.303 188.091,103.5 188.66,103.5 C190.041,103.5 191.16,102.381 191.16,101 C191.16,99.961 190.525,99.07 189.623,98.693 C189.644,98.619 189.661,98.543 189.681,98.468 C189.786,98.481 189.891,98.5 190,98.5" id="Fill-9" fill="#44D860"></path>
|
||||||
|
<path d="M60,38.5 C58.619,38.5 57.5,37.381 57.5,36 C57.5,31.864 54.136,28.5 50,28.5 C45.864,28.5 42.5,31.864 42.5,36 C42.5,37.381 41.381,38.5 40,38.5 C38.619,38.5 37.5,37.381 37.5,36 C37.5,29.107 43.107,23.5 50,23.5 C56.893,23.5 62.5,29.107 62.5,36 C62.5,37.381 61.381,38.5 60,38.5" id="Fill-10" fill="#000000"></path>
|
||||||
|
<path d="M100,166 L160,166 C171.046,166 180,157.046 180,146 L180,76 L120,76 C108.954,76 100,84.954 100,96 L100,166 Z" id="Fill-11" fill="#FFFF50"></path>
|
||||||
|
<path d="M165.0195,107 L114.9805,107 C114.4275,107 113.9805,106.553 113.9805,106 C113.9805,105.447 114.4275,105 114.9805,105 L165.0195,105 C165.5725,105 166.0195,105.447 166.0195,106 C166.0195,106.553 165.5725,107 165.0195,107" id="Fill-12" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,127 L114.9805,127 C114.4275,127 113.9805,126.553 113.9805,126 C113.9805,125.447 114.4275,125 114.9805,125 L165.0195,125 C165.5725,125 166.0195,125.447 166.0195,126 C166.0195,126.553 165.5725,127 165.0195,127" id="Fill-13" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,147 L114.9805,147 C114.4275,147 113.9805,146.553 113.9805,146 C113.9805,145.447 114.4275,145 114.9805,145 L165.0195,145 C165.5725,145 166.0195,145.447 166.0195,146 C166.0195,146.553 165.5725,147 165.0195,147" id="Fill-14" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,97.1855 L114.9805,97.1855 C114.4275,97.1855 113.9805,96.7375 113.9805,96.1855 C113.9805,95.6325 114.4275,95.1855 114.9805,95.1855 L165.0195,95.1855 C165.5725,95.1855 166.0195,95.6325 166.0195,96.1855 C166.0195,96.7375 165.5725,97.1855 165.0195,97.1855" id="Fill-15" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,117 L114.9805,117 C114.4275,117 113.9805,116.553 113.9805,116 C113.9805,115.447 114.4275,115 114.9805,115 L165.0195,115 C165.5725,115 166.0195,115.447 166.0195,116 C166.0195,116.553 165.5725,117 165.0195,117" id="Fill-16" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,137 L114.9805,137 C114.4275,137 113.9805,136.553 113.9805,136 C113.9805,135.447 114.4275,135 114.9805,135 L165.0195,135 C165.5725,135 166.0195,135.447 166.0195,136 C166.0195,136.553 165.5725,137 165.0195,137" id="Fill-17" fill="#000000"></path>
|
||||||
|
<path d="M180,44.6113 C179.988,44.6113 179.978,44.6053 179.966,44.6063 C176.876,44.7113 175.414,47.8023 174.124,50.5293 C172.778,53.3783 171.737,55.2323 170.031,55.1763 C168.142,55.1083 167.062,52.9743 165.918,50.7153 C164.604,48.1223 163.104,45.1803 159.955,45.2903 C156.909,45.3943 155.442,48.0843 154.148,50.4573 C152.771,52.9853 151.834,54.5223 150.027,54.4513 C148.1,54.3813 147.076,52.6463 145.891,50.6383 C144.57,48.4023 143.043,45.8883 139.955,45.9743 C136.961,46.0773 135.49,48.3593 134.192,50.3743 C132.819,52.5043 131.857,53.8023 130.027,53.7253 C128.054,53.6543 127.035,52.2153 125.856,50.5483 C124.532,48.6753 123.04,46.5553 119.961,46.6583 C117.033,46.7583 115.562,48.6273 114.265,50.2763 C113.033,51.8403 112.071,53.0783 110.036,53.0003 C109.484,52.9783 109.021,53.4113 109.001,53.9643 C108.98,54.5153 109.412,54.9793 109.964,55.0003 C112.981,55.1013 114.509,53.1993 115.836,51.5133 C117.013,50.0173 118.029,48.7263 120.029,48.6583 C121.955,48.5763 122.858,49.7733 124.224,51.7033 C125.521,53.5373 126.993,55.6173 129.955,55.7243 C133.058,55.8283 134.551,53.5093 135.873,51.4573 C137.055,49.6233 138.075,48.0403 140.023,47.9733 C141.816,47.9063 142.792,49.3233 144.168,51.6543 C145.465,53.8513 146.934,56.3403 149.955,56.4503 C153.08,56.5583 154.589,53.8293 155.904,51.4153 C157.043,49.3273 158.118,47.3543 160.023,47.2893 C161.816,47.2473 162.751,48.8843 164.134,51.6193 C165.426,54.1723 166.891,57.0643 169.959,57.1753 C170.016,57.1773 170.072,57.1783 170.128,57.1783 C173.192,57.1783 174.646,54.1033 175.933,51.3843 C177.072,48.9743 178.15,46.7033 180,46.6113 L180,44.6113 Z" id="Fill-24" fill="#000000"></path>
|
||||||
|
<polygon id="Fill-18" fill="#3ECC5F" points="80 166 120 166 120 126 80 126"></polygon>
|
||||||
|
<path d="M140,141 C139.781,141 139.572,141.037 139.361,141.064 C139.323,140.914 139.287,140.763 139.245,140.613 C141.051,139.859 142.32,138.079 142.32,136 C142.32,133.238 140.082,131 137.32,131 C136.182,131 135.145,131.396 134.304,132.036 C134.193,131.923 134.082,131.811 133.969,131.7 C134.596,130.864 134.98,129.838 134.98,128.713 C134.98,125.951 132.742,123.713 129.98,123.713 C127.915,123.713 126.143,124.966 125.381,126.754 C125.233,126.712 125.084,126.677 124.936,126.639 C124.963,126.428 125,126.219 125,126 C125,123.238 122.762,121 120,121 C117.238,121 115,123.238 115,126 C115,126.219 115.037,126.428 115.064,126.639 C114.916,126.677 114.767,126.712 114.619,126.754 C113.857,124.966 112.085,123.713 110.02,123.713 C107.258,123.713 105.02,125.951 105.02,128.713 C105.02,129.838 105.404,130.864 106.031,131.7 C102.314,135.332 100,140.393 100,146 C100,157.046 108.954,166 120,166 C129.339,166 137.16,159.59 139.361,150.936 C139.572,150.963 139.781,151 140,151 C142.762,151 145,148.762 145,146 C145,143.238 142.762,141 140,141" id="Fill-19" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-20" fill="#3ECC5F" points="80 106 120 106 120 86 80 86"></polygon>
|
||||||
|
<path d="M130,98.5 C131.381,98.5 132.5,97.381 132.5,96 C132.5,94.619 131.381,93.5 130,93.5 C129.891,93.5 129.786,93.519 129.681,93.532 C129.661,93.457 129.644,93.382 129.623,93.307 C130.525,92.93 131.16,92.039 131.16,91 C131.16,89.619 130.041,88.5 128.66,88.5 C128.091,88.5 127.572,88.697 127.152,89.018 C127.097,88.961 127.041,88.905 126.984,88.85 C127.298,88.433 127.49,87.919 127.49,87.356 C127.49,85.976 126.371,84.856 124.99,84.856 C123.957,84.856 123.071,85.483 122.69,86.377 C121.833,86.138 120.934,86 120,86 C114.478,86 110,90.478 110,96 C110,101.522 114.478,106 120,106 C120.934,106 121.833,105.862 122.69,105.623 C123.071,106.517 123.957,107.144 124.99,107.144 C126.371,107.144 127.49,106.024 127.49,104.644 C127.49,104.081 127.298,103.567 126.984,103.15 C127.041,103.095 127.097,103.039 127.152,102.982 C127.572,103.303 128.091,103.5 128.66,103.5 C130.041,103.5 131.16,102.381 131.16,101 C131.16,99.961 130.525,99.07 129.623,98.693 C129.644,98.619 129.661,98.543 129.681,98.468 C129.786,98.481 129.891,98.5 130,98.5" id="Fill-21" fill="#44D860"></path>
|
||||||
|
<path d="M140,24.75 C139.84,24.75 139.67,24.73 139.51,24.7 C139.35,24.67 139.189,24.62 139.04,24.56 C138.89,24.5 138.75,24.42 138.609,24.33 C138.479,24.24 138.35,24.13 138.229,24.02 C138.12,23.9 138.01,23.78 137.92,23.64 C137.83,23.5 137.75,23.36 137.689,23.21 C137.63,23.06 137.58,22.9 137.55,22.74 C137.52,22.58 137.5,22.41 137.5,22.25 C137.5,22.09 137.52,21.92 137.55,21.76 C137.58,21.6 137.63,21.45 137.689,21.29 C137.75,21.14 137.83,21 137.92,20.86 C138.01,20.73 138.12,20.6 138.229,20.48 C138.35,20.37 138.479,20.26 138.609,20.17 C138.75,20.08 138.89,20 139.04,19.94 C139.189,19.88 139.35,19.83 139.51,19.8 C139.83,19.73 140.16,19.73 140.49,19.8 C140.649,19.83 140.81,19.88 140.96,19.94 C141.109,20 141.25,20.08 141.39,20.17 C141.52,20.26 141.649,20.37 141.77,20.48 C141.88,20.6 141.99,20.73 142.08,20.86 C142.17,21 142.25,21.14 142.31,21.29 C142.37,21.45 142.42,21.6 142.45,21.76 C142.479,21.92 142.5,22.09 142.5,22.25 C142.5,22.91 142.229,23.56 141.77,24.02 C141.649,24.13 141.52,24.24 141.39,24.33 C141.25,24.42 141.109,24.5 140.96,24.56 C140.81,24.62 140.649,24.67 140.49,24.7 C140.33,24.73 140.16,24.75 140,24.75" id="Fill-22" fill="#000000"></path>
|
||||||
|
<path d="M160,23.5 C159.34,23.5 158.7,23.23 158.229,22.77 C158.12,22.65 158.01,22.52 157.92,22.39 C157.83,22.25 157.75,22.11 157.689,21.96 C157.63,21.81 157.58,21.65 157.55,21.49 C157.52,21.33 157.5,21.16 157.5,21 C157.5,20.34 157.77,19.7 158.229,19.23 C158.35,19.12 158.479,19.01 158.609,18.92 C158.75,18.83 158.89,18.75 159.04,18.69 C159.189,18.63 159.35,18.58 159.51,18.55 C159.83,18.48 160.17,18.48 160.49,18.55 C160.649,18.58 160.81,18.63 160.96,18.69 C161.109,18.75 161.25,18.83 161.39,18.92 C161.52,19.01 161.649,19.12 161.77,19.23 C162.229,19.7 162.5,20.34 162.5,21 C162.5,21.16 162.479,21.33 162.45,21.49 C162.42,21.65 162.37,21.81 162.31,21.96 C162.24,22.11 162.17,22.25 162.08,22.39 C161.99,22.52 161.88,22.65 161.77,22.77 C161.649,22.88 161.52,22.99 161.39,23.08 C161.25,23.17 161.109,23.25 160.96,23.31 C160.81,23.37 160.649,23.42 160.49,23.45 C160.33,23.48 160.16,23.5 160,23.5" id="Fill-23" fill="#000000"></path>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 13 KiB |
155
img/docusaurus_keytar.svg
Normal file
155
img/docusaurus_keytar.svg
Normal file
|
|
@ -0,0 +1,155 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="200px" height="200px" viewBox="0 0 200 200" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
|
||||||
|
<title>docusaurus_keytar</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs>
|
||||||
|
<path d="M4.88271903,0.0904207227 L4.88271903,1.17009735 L4.88271903,1.17009735 C4.88271903,1.7223821 4.43500378,2.17009735 3.88271903,2.17009735 L1,2.17009735 C0.44771525,2.17009735 -9.92435301e-14,1.7223821 -9.93094496e-14,1.17009735 L-9.93094496e-14,0.0904207227 L4.88271903,0.0904207227 Z" id="path-1"></path>
|
||||||
|
<path d="M4.88271903,0.0904207227 L4.88271903,1.17009735 C4.88271903,1.7223821 4.43500378,2.17009735 3.88271903,2.17009735 L1,2.17009735 C0.44771525,2.17009735 -9.92851634e-14,1.7223821 -9.95974136e-14,1.17009735 L-9.95974136e-14,0.0904207227 L4.88271903,0.0904207227 Z" id="path-3"></path>
|
||||||
|
</defs>
|
||||||
|
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<g id="docusaurus_keytar">
|
||||||
|
<rect id="Rectangle" fill="#FFFFFF" x="99" y="52" width="84" height="34"></rect>
|
||||||
|
<g id="Group-2" transform="translate(3.000000, 17.000000)">
|
||||||
|
<path d="M20,146 C12.602,146 6.157,141.973 2.697,136 C0.992,138.944 0,142.353 0,146 C0,157.046 8.954,166 20,166 L40,166 L40,146 L20,146 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<path d="M109.9805,40.376 L180.0005,36 L180.0005,26 C180.0005,14.954 171.0455,6 160.0005,6 L70.0005,6 L67.5005,1.67 C66.3885,-0.255 63.6115,-0.255 62.5005,1.67 L60.0005,6 L57.5005,1.67 C56.3885,-0.255 53.6115,-0.255 52.5005,1.67 L50.0005,6 L47.5005,1.67 C46.3885,-0.255 43.6115,-0.255 42.5005,1.67 L40.0005,6 C39.9785,6 39.9575,6.003 39.9355,6.003 L35.7935,1.862 C34.2225,0.291 31.5405,1.009 30.9645,3.156 L29.5965,8.26 L24.4035,6.868 C22.2565,6.293 20.2925,8.257 20.8685,10.404 L22.2595,15.597 L17.1565,16.964 C15.0095,17.54 14.2905,20.223 15.8615,21.794 L20.0025,25.936 C20.0025,25.957 20.0005,25.978 20.0005,26 L15.6695,28.5 C13.7455,29.611 13.7455,32.389 15.6695,33.5 L20.0005,36 L15.6695,38.5 C13.7455,39.611 13.7455,42.389 15.6695,43.5 L20.0005,46 L15.6695,48.5 C13.7455,49.611 13.7455,52.389 15.6695,53.5 L20.0005,56 L15.6695,58.5 C13.7455,59.611 13.7455,62.389 15.6695,63.5 L20.0005,66 L15.6695,68.5 C13.7455,69.611 13.7455,72.389 15.6695,73.5 L20.0005,76 L15.6695,78.5 C13.7455,79.611 13.7455,82.389 15.6695,83.5 L20.0005,86 L15.6695,88.5 C13.7455,89.611 13.7455,92.389 15.6695,93.5 L20.0005,96 L15.6695,98.5 C13.7455,99.611 13.7455,102.389 15.6695,103.5 L20.0005,106 L15.6695,108.5 C13.7455,109.611 13.7455,112.389 15.6695,113.5 L20.0005,116 L15.6695,118.5 C13.7455,119.611 13.7455,122.389 15.6695,123.5 L20.0005,126 L15.6695,128.5 C13.7455,129.611 13.7455,132.389 15.6695,133.5 L20.0005,136 L15.6695,138.5 C13.7455,139.611 13.7455,142.389 15.6695,143.5 L20.0005,146 C20.0005,157.046 28.9545,166 40.0005,166 L160.0005,166 C171.0455,166 180.0005,157.046 180.0005,146 L180.0005,66 L109.9805,61.624 C104.3705,61.273 100.0005,56.621 100.0005,51 C100.0005,45.379 104.3705,40.727 109.9805,40.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-5" fill="#3ECC5F" points="140 166 170 166 170 126 140 126"></polygon>
|
||||||
|
<path d="M190,141 C189.781,141 189.572,141.037 189.361,141.064 C189.323,140.914 189.287,140.763 189.245,140.613 C191.051,139.859 192.32,138.079 192.32,136 C192.32,133.238 190.082,131 187.32,131 C186.182,131 185.145,131.396 184.304,132.036 C184.193,131.923 184.082,131.811 183.969,131.7 C184.596,130.864 184.98,129.838 184.98,128.713 C184.98,125.951 182.742,123.713 179.98,123.713 C177.915,123.713 176.143,124.966 175.381,126.754 C175.233,126.712 175.084,126.677 174.936,126.639 C174.963,126.428 175,126.219 175,126 C175,123.238 172.762,121 170,121 C167.238,121 165,123.238 165,126 C165,126.219 165.037,126.428 165.064,126.639 C164.916,126.677 164.767,126.712 164.619,126.754 C163.857,124.966 162.085,123.713 160.02,123.713 C157.258,123.713 155.02,125.951 155.02,128.713 C155.02,129.838 155.404,130.864 156.031,131.7 C152.314,135.332 150,140.393 150,146 C150,157.046 158.954,166 170,166 C179.339,166 187.16,159.59 189.361,150.936 C189.572,150.963 189.781,151 190,151 C192.762,151 195,148.762 195,146 C195,143.238 192.762,141 190,141" id="Fill-7" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-8" fill="#3ECC5F" points="150 106 180 106 180 86 150 86"></polygon>
|
||||||
|
<path d="M190,98.5 C191.381,98.5 192.5,97.381 192.5,96 C192.5,94.619 191.381,93.5 190,93.5 C189.891,93.5 189.786,93.519 189.681,93.532 C189.661,93.457 189.644,93.382 189.623,93.307 C190.525,92.93 191.16,92.039 191.16,91 C191.16,89.619 190.041,88.5 188.66,88.5 C188.091,88.5 187.572,88.697 187.152,89.018 C187.097,88.961 187.041,88.905 186.984,88.85 C187.298,88.433 187.49,87.919 187.49,87.356 C187.49,85.976 186.371,84.856 184.99,84.856 C183.957,84.856 183.071,85.483 182.69,86.377 C181.833,86.138 180.934,86 180,86 C174.478,86 170,90.478 170,96 C170,101.522 174.478,106 180,106 C180.934,106 181.833,105.862 182.69,105.623 C183.071,106.517 183.957,107.144 184.99,107.144 C186.371,107.144 187.49,106.024 187.49,104.644 C187.49,104.081 187.298,103.567 186.984,103.15 C187.041,103.095 187.097,103.039 187.152,102.982 C187.572,103.303 188.091,103.5 188.66,103.5 C190.041,103.5 191.16,102.381 191.16,101 C191.16,99.961 190.525,99.07 189.623,98.693 C189.644,98.619 189.661,98.543 189.681,98.468 C189.786,98.481 189.891,98.5 190,98.5" id="Fill-9" fill="#44D860"></path>
|
||||||
|
<path d="M60,38.5 C58.619,38.5 57.5,37.381 57.5,36 C57.5,31.864 54.136,28.5 50,28.5 C45.864,28.5 42.5,31.864 42.5,36 C42.5,37.381 41.381,38.5 40,38.5 C38.619,38.5 37.5,37.381 37.5,36 C37.5,29.107 43.107,23.5 50,23.5 C56.893,23.5 62.5,29.107 62.5,36 C62.5,37.381 61.381,38.5 60,38.5" id="Fill-10" fill="#000000"></path>
|
||||||
|
<path d="M100,166 L160,166 C171.046,166 180,157.046 180,146 L180,76 L120,76 C108.954,76 100,84.954 100,96 L100,166 Z" id="Fill-11" fill="#FFFF50"></path>
|
||||||
|
<path d="M165.0195,107 L114.9805,107 C114.4275,107 113.9805,106.553 113.9805,106 C113.9805,105.447 114.4275,105 114.9805,105 L165.0195,105 C165.5725,105 166.0195,105.447 166.0195,106 C166.0195,106.553 165.5725,107 165.0195,107" id="Fill-12" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,127 L114.9805,127 C114.4275,127 113.9805,126.553 113.9805,126 C113.9805,125.447 114.4275,125 114.9805,125 L165.0195,125 C165.5725,125 166.0195,125.447 166.0195,126 C166.0195,126.553 165.5725,127 165.0195,127" id="Fill-13" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,147 L114.9805,147 C114.4275,147 113.9805,146.553 113.9805,146 C113.9805,145.447 114.4275,145 114.9805,145 L165.0195,145 C165.5725,145 166.0195,145.447 166.0195,146 C166.0195,146.553 165.5725,147 165.0195,147" id="Fill-14" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,97.1855 L114.9805,97.1855 C114.4275,97.1855 113.9805,96.7375 113.9805,96.1855 C113.9805,95.6325 114.4275,95.1855 114.9805,95.1855 L165.0195,95.1855 C165.5725,95.1855 166.0195,95.6325 166.0195,96.1855 C166.0195,96.7375 165.5725,97.1855 165.0195,97.1855" id="Fill-15" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,117 L114.9805,117 C114.4275,117 113.9805,116.553 113.9805,116 C113.9805,115.447 114.4275,115 114.9805,115 L165.0195,115 C165.5725,115 166.0195,115.447 166.0195,116 C166.0195,116.553 165.5725,117 165.0195,117" id="Fill-16" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,137 L114.9805,137 C114.4275,137 113.9805,136.553 113.9805,136 C113.9805,135.447 114.4275,135 114.9805,135 L165.0195,135 C165.5725,135 166.0195,135.447 166.0195,136 C166.0195,136.553 165.5725,137 165.0195,137" id="Fill-17" fill="#000000"></path>
|
||||||
|
<path d="M180,44.6113 C179.988,44.6113 179.978,44.6053 179.966,44.6063 C176.876,44.7113 175.414,47.8023 174.124,50.5293 C172.778,53.3783 171.737,55.2323 170.031,55.1763 C168.142,55.1083 167.062,52.9743 165.918,50.7153 C164.604,48.1223 163.104,45.1803 159.955,45.2903 C156.909,45.3943 155.442,48.0843 154.148,50.4573 C152.771,52.9853 151.834,54.5223 150.027,54.4513 C148.1,54.3813 147.076,52.6463 145.891,50.6383 C144.57,48.4023 143.043,45.8883 139.955,45.9743 C136.961,46.0773 135.49,48.3593 134.192,50.3743 C132.819,52.5043 131.857,53.8023 130.027,53.7253 C128.054,53.6543 127.035,52.2153 125.856,50.5483 C124.532,48.6753 123.04,46.5553 119.961,46.6583 C117.033,46.7583 115.562,48.6273 114.265,50.2763 C113.033,51.8403 112.071,53.0783 110.036,53.0003 C109.484,52.9783 109.021,53.4113 109.001,53.9643 C108.98,54.5153 109.412,54.9793 109.964,55.0003 C112.981,55.1013 114.509,53.1993 115.836,51.5133 C117.013,50.0173 118.029,48.7263 120.029,48.6583 C121.955,48.5763 122.858,49.7733 124.224,51.7033 C125.521,53.5373 126.993,55.6173 129.955,55.7243 C133.058,55.8283 134.551,53.5093 135.873,51.4573 C137.055,49.6233 138.075,48.0403 140.023,47.9733 C141.816,47.9063 142.792,49.3233 144.168,51.6543 C145.465,53.8513 146.934,56.3403 149.955,56.4503 C153.08,56.5583 154.589,53.8293 155.904,51.4153 C157.043,49.3273 158.118,47.3543 160.023,47.2893 C161.816,47.2473 162.751,48.8843 164.134,51.6193 C165.426,54.1723 166.891,57.0643 169.959,57.1753 C170.016,57.1773 170.072,57.1783 170.128,57.1783 C173.192,57.1783 174.646,54.1033 175.933,51.3843 C177.072,48.9743 178.15,46.7033 180,46.6113 L180,44.6113 Z" id="Fill-24" fill="#000000"></path>
|
||||||
|
<polygon id="Fill-18" fill="#3ECC5F" points="80 166 120 166 120 126 80 126"></polygon>
|
||||||
|
<g id="Group-3" transform="translate(145.451771, 89.000000) rotate(-15.000000) translate(-145.451771, -89.000000) translate(102.951771, 72.000000)">
|
||||||
|
<rect id="Rectangle-6" fill="#D8D8D8" x="0.0459167733" y="0.0141282379" width="84.5221834" height="33.3670127" rx="2"></rect>
|
||||||
|
<g id="Group-6" transform="translate(1.000000, 20.750000)" fill="#4A4A4A">
|
||||||
|
<rect id="Rectangle-7" x="15.8182544" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="21.6051807" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="27.3921069" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="33.1790332" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="38.9659594" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="44.7528857" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="50.539812" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="56.3267382" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="62.1136645" y="0.339290564" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<path d="M1.44673156,0.339290564 L13.7332058,0.339290564 L13.7332058,0.339290564 C14.2854905,0.339290564 14.7332058,0.787005814 14.7332058,1.33929056 L14.7332058,4.22200959 L14.7332058,4.22200959 C14.7332058,4.77429434 14.2854905,5.22200959 13.7332058,5.22200959 L1.44673156,5.22200959 L1.44673156,5.22200959 C0.894446814,5.22200959 0.446731564,4.77429434 0.446731564,4.22200959 L0.446731564,1.33929056 L0.446731564,1.33929056 C0.446731564,0.787005814 0.894446814,0.339290564 1.44673156,0.339290564 Z" id="Rectangle-7"></path>
|
||||||
|
<path d="M69.0814322,0.339290564 L81.3679064,0.339290564 L81.3679064,0.339290564 C81.9201911,0.339290564 82.3679064,0.787005814 82.3679064,1.33929056 L82.3679064,4.22200959 L82.3679064,4.22200959 C82.3679064,4.77429434 81.9201911,5.22200959 81.3679064,5.22200959 L69.0814322,5.22200959 L69.0814322,5.22200959 C68.5291474,5.22200959 68.0814322,4.77429434 68.0814322,4.22200959 L68.0814322,1.33929056 L68.0814322,1.33929056 C68.0814322,0.787005814 68.5291474,0.339290564 69.0814322,0.339290564 Z" id="Rectangle-7"></path>
|
||||||
|
</g>
|
||||||
|
<g id="Group-4" transform="translate(1.000000, 9.000000)" fill="#4A4A4A">
|
||||||
|
<path d="M1.44673156,0.403755164 L6.13786505,0.403755164 L6.13786505,0.403755164 C6.6901498,0.403755164 7.13786505,0.851470414 7.13786505,1.40375516 L7.13786505,4.28647419 L7.13786505,4.28647419 C7.13786505,4.83875894 6.6901498,5.28647419 6.13786505,5.28647419 L1.44673156,5.28647419 L1.44673156,5.28647419 C0.894446814,5.28647419 0.446731564,4.83875894 0.446731564,4.28647419 L0.446731564,1.40375516 L0.446731564,1.40375516 C0.446731564,0.851470414 0.894446814,0.403755164 1.44673156,0.403755164 Z" id="Rectangle-7"></path>
|
||||||
|
<rect id="Rectangle-7" x="8.04207227" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="13.8289985" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="19.6159248" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="25.402851" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="31.1897773" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="36.9767035" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="42.7636298" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="48.5505561" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="54.3374823" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="60.1244086" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="65.9113348" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="71.6982611" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="77.4851873" y="0.403755164" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
</g>
|
||||||
|
<g id="Group" transform="translate(42.367906, 6.250000) rotate(-180.000000) translate(-42.367906, -6.250000) translate(1.367906, 3.750000)" fill="#4A4A4A">
|
||||||
|
<path d="M1,1.06204379e-16 L5.69113348,-6.40356908e-18 L5.69113348,2.22044605e-16 C6.24341823,6.11117331e-16 6.69113348,0.44771525 6.69113348,1 L6.69113348,3.88271903 L6.69113348,3.88271903 C6.69113348,4.43500378 6.24341823,4.88271903 5.69113348,4.88271903 L1,4.88271903 L1,4.88271903 C0.44771525,4.88271903 6.76353751e-17,4.43500378 0,3.88271903 L0,1 L0,1 C-6.76353751e-17,0.44771525 0.44771525,3.23498823e-16 1,2.22044605e-16 Z" id="Rectangle-7"></path>
|
||||||
|
<rect id="Rectangle-7" x="7.59534071" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="13.382267" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="19.1691932" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="24.9561195" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="30.7430457" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="36.529972" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="42.3168982" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="48.1038245" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="53.8907507" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="59.677677" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="65.4646033" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="71.2515295" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="77.0384558" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="7.59534071" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="13.382267" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="19.1691932" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="24.9561195" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="30.7430457" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="36.529972" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="42.3168982" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="48.1038245" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="53.8907507" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="59.677677" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="65.4646033" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="71.2515295" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="77.0384558" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
</g>
|
||||||
|
<g id="Group-5" transform="translate(1.000000, 15.000000)" fill="#4A4A4A">
|
||||||
|
<path d="M1.44673156,0.190681419 L8.12712095,0.190681419 L8.12712095,0.190681419 C8.6794057,0.190681419 9.12712095,0.638396669 9.12712095,1.19068142 L9.12712095,4.07340045 L9.12712095,4.07340045 C9.12712095,4.6256852 8.6794057,5.07340045 8.12712095,5.07340045 L1.44673156,5.07340045 L1.44673156,5.07340045 C0.894446814,5.07340045 0.446731564,4.6256852 0.446731564,4.07340045 L0.446731564,1.19068142 L0.446731564,1.19068142 C0.446731564,0.638396669 0.894446814,0.190681419 1.44673156,0.190681419 Z" id="Rectangle-7"></path>
|
||||||
|
<g id="Group-2" transform="translate(10.212170, 0.190681)">
|
||||||
|
<rect id="Rectangle-7" x="0" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="5.78692625" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="11.5738525" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="17.3607788" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="23.147705" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="28.9346313" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="34.7215575" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="40.5084838" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="46.29541" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="52.0823363" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" x="57.8692625" y="0" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
</g>
|
||||||
|
<path d="M75.0491999,0.190681419 L81.3679064,0.190681419 L81.3679064,0.190681419 C81.9201911,0.190681419 82.3679064,0.638396669 82.3679064,1.19068142 L82.3679064,4.07340045 L82.3679064,4.07340045 C82.3679064,4.6256852 81.9201911,5.07340045 81.3679064,5.07340045 L75.0491999,5.07340045 L75.0491999,5.07340045 C74.4969151,5.07340045 74.0491999,4.6256852 74.0491999,4.07340045 L74.0491999,1.19068142 L74.0491999,1.19068142 C74.0491999,0.638396669 74.4969151,0.190681419 75.0491999,0.190681419 Z" id="Rectangle-7"></path>
|
||||||
|
</g>
|
||||||
|
<g id="Group-7" transform="translate(1.000000, 26.000000)">
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="0.446731564" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="6.23365782" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="12.0205841" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="17.8075103" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<path d="M24.5944366,1.12621682 L52.4332751,1.12621682 L52.4332751,1.12621682 C52.9855598,1.12621682 53.4332751,1.57393207 53.4332751,2.12621682 L53.4332751,5.00893585 L53.4332751,5.00893585 C53.4332751,5.5612206 52.9855598,6.00893585 52.4332751,6.00893585 L24.5944366,6.00893585 L24.5944366,6.00893585 C24.0421518,6.00893585 23.5944366,5.5612206 23.5944366,5.00893585 L23.5944366,2.12621682 L23.5944366,2.12621682 C23.5944366,1.57393207 24.0421518,1.12621682 24.5944366,1.12621682 Z" id="Rectangle-7" fill="#4A4A4A"></path>
|
||||||
|
<path d="M55.3374823,1.12621682 L58.9435671,1.12621682 L58.9435671,1.12621682 C59.4958519,1.12621682 59.9435671,1.57393207 59.9435671,2.12621682 L59.9435671,5.00893585 L59.9435671,5.00893585 C59.9435671,5.5612206 59.4958519,6.00893585 58.9435671,6.00893585 L55.3374823,6.00893585 L55.3374823,6.00893585 C54.7851976,6.00893585 54.3374823,5.5612206 54.3374823,5.00893585 L54.3374823,2.12621682 L54.3374823,2.12621682 C54.3374823,1.57393207 54.7851976,1.12621682 55.3374823,1.12621682 Z" id="Rectangle-7" fill="#4A4A4A"></path>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="60.8477743" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="66.6347006" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<rect id="Rectangle-7" fill="#4A4A4A" x="77.4851873" y="1.12621682" width="4.88271903" height="4.88271903" rx="1"></rect>
|
||||||
|
<g id="Rectangle-8" transform="translate(74.442663, 1.796314) rotate(-180.000000) translate(-74.442663, -1.796314) translate(71.942663, 0.296314)">
|
||||||
|
<mask id="mask-2" fill="white">
|
||||||
|
<use xlink:href="#path-1"></use>
|
||||||
|
</mask>
|
||||||
|
<use id="Combined-Shape" fill="#4A4A4A" xlink:href="#path-1"></use>
|
||||||
|
</g>
|
||||||
|
<g id="Rectangle-8" transform="translate(74.559944, 5.338839) rotate(-360.000000) translate(-74.559944, -5.338839) translate(72.059944, 3.838839)">
|
||||||
|
<mask id="mask-4" fill="white">
|
||||||
|
<use xlink:href="#path-3"></use>
|
||||||
|
</mask>
|
||||||
|
<use id="Combined-Shape" fill="#4A4A4A" xlink:href="#path-3"></use>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
<rect id="Rectangle-9" fill="#4A4A4A" x="1.80841445" y="1.08504867" width="81.3786505" height="2.17009735" rx="1.08504867"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="3.79767035" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="10.0421793" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="14.8456478" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="19.6491162" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="24.4525847" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="30.4569202" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="35.2603887" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="40.0638571" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="44.8673255" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="50.8716611" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="55.6751295" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="60.478598" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="66.4829335" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="71.286402" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
<rect id="Rectangle-10" fill="#D8D8D8" opacity="0.135643116" x="76.0898704" y="1.44673156" width="4.56329502" height="1.44673156" rx="0.723365782"></rect>
|
||||||
|
</g>
|
||||||
|
<path d="M140,141 C139.781,141 139.572,141.037 139.361,141.064 C139.323,140.914 139.287,140.763 139.245,140.613 C141.051,139.859 142.32,138.079 142.32,136 C142.32,133.238 140.082,131 137.32,131 C136.182,131 135.145,131.396 134.304,132.036 C134.193,131.923 134.082,131.811 133.969,131.7 C134.596,130.864 134.98,129.838 134.98,128.713 C134.98,125.951 132.742,123.713 129.98,123.713 C127.915,123.713 126.143,124.966 125.381,126.754 C125.233,126.712 125.084,126.677 124.936,126.639 C124.963,126.428 125,126.219 125,126 C125,123.238 122.762,121 120,121 C117.238,121 115,123.238 115,126 C115,126.219 115.037,126.428 115.064,126.639 C114.916,126.677 114.767,126.712 114.619,126.754 C113.857,124.966 112.085,123.713 110.02,123.713 C107.258,123.713 105.02,125.951 105.02,128.713 C105.02,129.838 105.404,130.864 106.031,131.7 C102.314,135.332 100,140.393 100,146 C100,157.046 108.954,166 120,166 C129.339,166 137.16,159.59 139.361,150.936 C139.572,150.963 139.781,151 140,151 C142.762,151 145,148.762 145,146 C145,143.238 142.762,141 140,141" id="Fill-19" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-20" fill="#3ECC5F" points="80 106 120 106 120 86 80 86"></polygon>
|
||||||
|
<path d="M130,98.5 C131.381,98.5 132.5,97.381 132.5,96 C132.5,94.619 131.381,93.5 130,93.5 C129.891,93.5 129.786,93.519 129.681,93.532 C129.661,93.457 129.644,93.382 129.623,93.307 C130.525,92.93 131.16,92.039 131.16,91 C131.16,89.619 130.041,88.5 128.66,88.5 C128.091,88.5 127.572,88.697 127.152,89.018 C127.097,88.961 127.041,88.905 126.984,88.85 C127.298,88.433 127.49,87.919 127.49,87.356 C127.49,85.976 126.371,84.856 124.99,84.856 C123.957,84.856 123.071,85.483 122.69,86.377 C121.833,86.138 120.934,86 120,86 C114.478,86 110,90.478 110,96 C110,101.522 114.478,106 120,106 C120.934,106 121.833,105.862 122.69,105.623 C123.071,106.517 123.957,107.144 124.99,107.144 C126.371,107.144 127.49,106.024 127.49,104.644 C127.49,104.081 127.298,103.567 126.984,103.15 C127.041,103.095 127.097,103.039 127.152,102.982 C127.572,103.303 128.091,103.5 128.66,103.5 C130.041,103.5 131.16,102.381 131.16,101 C131.16,99.961 130.525,99.07 129.623,98.693 C129.644,98.619 129.661,98.543 129.681,98.468 C129.786,98.481 129.891,98.5 130,98.5" id="Fill-21" fill="#44D860"></path>
|
||||||
|
<path d="M140,24.75 C139.84,24.75 139.67,24.73 139.51,24.7 C139.35,24.67 139.189,24.62 139.04,24.56 C138.89,24.5 138.75,24.42 138.609,24.33 C138.479,24.24 138.35,24.13 138.229,24.02 C138.12,23.9 138.01,23.78 137.92,23.64 C137.83,23.5 137.75,23.36 137.689,23.21 C137.63,23.06 137.58,22.9 137.55,22.74 C137.52,22.58 137.5,22.41 137.5,22.25 C137.5,22.09 137.52,21.92 137.55,21.76 C137.58,21.6 137.63,21.45 137.689,21.29 C137.75,21.14 137.83,21 137.92,20.86 C138.01,20.73 138.12,20.6 138.229,20.48 C138.35,20.37 138.479,20.26 138.609,20.17 C138.75,20.08 138.89,20 139.04,19.94 C139.189,19.88 139.35,19.83 139.51,19.8 C139.83,19.73 140.16,19.73 140.49,19.8 C140.649,19.83 140.81,19.88 140.96,19.94 C141.109,20 141.25,20.08 141.39,20.17 C141.52,20.26 141.649,20.37 141.77,20.48 C141.88,20.6 141.99,20.73 142.08,20.86 C142.17,21 142.25,21.14 142.31,21.29 C142.37,21.45 142.42,21.6 142.45,21.76 C142.479,21.92 142.5,22.09 142.5,22.25 C142.5,22.91 142.229,23.56 141.77,24.02 C141.649,24.13 141.52,24.24 141.39,24.33 C141.25,24.42 141.109,24.5 140.96,24.56 C140.81,24.62 140.649,24.67 140.49,24.7 C140.33,24.73 140.16,24.75 140,24.75" id="Fill-22" fill="#000000"></path>
|
||||||
|
<path d="M160,23.5 C159.34,23.5 158.7,23.23 158.229,22.77 C158.12,22.65 158.01,22.52 157.92,22.39 C157.83,22.25 157.75,22.11 157.689,21.96 C157.63,21.81 157.58,21.65 157.55,21.49 C157.52,21.33 157.5,21.16 157.5,21 C157.5,20.34 157.77,19.7 158.229,19.23 C158.35,19.12 158.479,19.01 158.609,18.92 C158.75,18.83 158.89,18.75 159.04,18.69 C159.189,18.63 159.35,18.58 159.51,18.55 C159.83,18.48 160.17,18.48 160.49,18.55 C160.649,18.58 160.81,18.63 160.96,18.69 C161.109,18.75 161.25,18.83 161.39,18.92 C161.52,19.01 161.649,19.12 161.77,19.23 C162.229,19.7 162.5,20.34 162.5,21 C162.5,21.16 162.479,21.33 162.45,21.49 C162.42,21.65 162.37,21.81 162.31,21.96 C162.24,22.11 162.17,22.25 162.08,22.39 C161.99,22.52 161.88,22.65 161.77,22.77 C161.649,22.88 161.52,22.99 161.39,23.08 C161.25,23.17 161.109,23.25 160.96,23.31 C160.81,23.37 160.649,23.42 160.49,23.45 C160.33,23.48 160.16,23.5 160,23.5" id="Fill-23" fill="#000000"></path>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 31 KiB |
BIN
img/docusaurus_live.gif
Normal file
BIN
img/docusaurus_live.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 692 KiB |
BIN
img/docusaurus_live.webp
Normal file
BIN
img/docusaurus_live.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 121 KiB |
35
img/docusaurus_monochrome.svg
Normal file
35
img/docusaurus_monochrome.svg
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="200px" height="200px" viewBox="0 0 200 200" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
|
||||||
|
<title>docusaurus_monochrome</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs></defs>
|
||||||
|
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" opacity="0.75">
|
||||||
|
<g id="docusaurus_monochrome">
|
||||||
|
<g id="Group" transform="translate(3.000000, 17.000000)">
|
||||||
|
<path d="M20,146 C12.602,146 6.157,141.973 2.697,136 C0.992,138.944 0,142.353 0,146 C0,157.046 8.954,166 20,166 L40,166 L40,146 L20,146 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<rect id="Rectangle" fill="#CAFFD6" x="96" y="35" width="84" height="34"></rect>
|
||||||
|
<path d="M109.9805,40.376 L180.0005,36 L180.0005,26 C180.0005,14.954 171.0455,6 160.0005,6 L70.0005,6 L67.5005,1.67 C66.3885,-0.255 63.6115,-0.255 62.5005,1.67 L60.0005,6 L57.5005,1.67 C56.3885,-0.255 53.6115,-0.255 52.5005,1.67 L50.0005,6 L47.5005,1.67 C46.3885,-0.255 43.6115,-0.255 42.5005,1.67 L40.0005,6 C39.9785,6 39.9575,6.003 39.9355,6.003 L35.7935,1.862 C34.2225,0.291 31.5405,1.009 30.9645,3.156 L29.5965,8.26 L24.4035,6.868 C22.2565,6.293 20.2925,8.257 20.8685,10.404 L22.2595,15.597 L17.1565,16.964 C15.0095,17.54 14.2905,20.223 15.8615,21.794 L20.0025,25.936 C20.0025,25.957 20.0005,25.978 20.0005,26 L15.6695,28.5 C13.7455,29.611 13.7455,32.389 15.6695,33.5 L20.0005,36 L15.6695,38.5 C13.7455,39.611 13.7455,42.389 15.6695,43.5 L20.0005,46 L15.6695,48.5 C13.7455,49.611 13.7455,52.389 15.6695,53.5 L20.0005,56 L15.6695,58.5 C13.7455,59.611 13.7455,62.389 15.6695,63.5 L20.0005,66 L15.6695,68.5 C13.7455,69.611 13.7455,72.389 15.6695,73.5 L20.0005,76 L15.6695,78.5 C13.7455,79.611 13.7455,82.389 15.6695,83.5 L20.0005,86 L15.6695,88.5 C13.7455,89.611 13.7455,92.389 15.6695,93.5 L20.0005,96 L15.6695,98.5 C13.7455,99.611 13.7455,102.389 15.6695,103.5 L20.0005,106 L15.6695,108.5 C13.7455,109.611 13.7455,112.389 15.6695,113.5 L20.0005,116 L15.6695,118.5 C13.7455,119.611 13.7455,122.389 15.6695,123.5 L20.0005,126 L15.6695,128.5 C13.7455,129.611 13.7455,132.389 15.6695,133.5 L20.0005,136 L15.6695,138.5 C13.7455,139.611 13.7455,142.389 15.6695,143.5 L20.0005,146 C20.0005,157.046 28.9545,166 40.0005,166 L160.0005,166 C171.0455,166 180.0005,157.046 180.0005,146 L180.0005,66 L109.9805,61.624 C104.3705,61.273 100.0005,56.621 100.0005,51 C100.0005,45.379 104.3705,40.727 109.9805,40.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-5" fill="#3ECC5F" points="140 166 170 166 170 126 140 126"></polygon>
|
||||||
|
<path d="M190,141 C189.781,141 189.572,141.037 189.361,141.064 C189.323,140.914 189.287,140.763 189.245,140.613 C191.051,139.859 192.32,138.079 192.32,136 C192.32,133.238 190.082,131 187.32,131 C186.182,131 185.145,131.396 184.304,132.036 C184.193,131.923 184.082,131.811 183.969,131.7 C184.596,130.864 184.98,129.838 184.98,128.713 C184.98,125.951 182.742,123.713 179.98,123.713 C177.915,123.713 176.143,124.966 175.381,126.754 C175.233,126.712 175.084,126.677 174.936,126.639 C174.963,126.428 175,126.219 175,126 C175,123.238 172.762,121 170,121 C167.238,121 165,123.238 165,126 C165,126.219 165.037,126.428 165.064,126.639 C164.916,126.677 164.767,126.712 164.619,126.754 C163.857,124.966 162.085,123.713 160.02,123.713 C157.258,123.713 155.02,125.951 155.02,128.713 C155.02,129.838 155.404,130.864 156.031,131.7 C152.314,135.332 150,140.393 150,146 C150,157.046 158.954,166 170,166 C179.339,166 187.16,159.59 189.361,150.936 C189.572,150.963 189.781,151 190,151 C192.762,151 195,148.762 195,146 C195,143.238 192.762,141 190,141" id="Fill-7" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-8" fill="#3ECC5F" points="150 106 180 106 180 86 150 86"></polygon>
|
||||||
|
<path d="M190,98.5 C191.381,98.5 192.5,97.381 192.5,96 C192.5,94.619 191.381,93.5 190,93.5 C189.891,93.5 189.786,93.519 189.681,93.532 C189.661,93.457 189.644,93.382 189.623,93.307 C190.525,92.93 191.16,92.039 191.16,91 C191.16,89.619 190.041,88.5 188.66,88.5 C188.091,88.5 187.572,88.697 187.152,89.018 C187.097,88.961 187.041,88.905 186.984,88.85 C187.298,88.433 187.49,87.919 187.49,87.356 C187.49,85.976 186.371,84.856 184.99,84.856 C183.957,84.856 183.071,85.483 182.69,86.377 C181.833,86.138 180.934,86 180,86 C174.478,86 170,90.478 170,96 C170,101.522 174.478,106 180,106 C180.934,106 181.833,105.862 182.69,105.623 C183.071,106.517 183.957,107.144 184.99,107.144 C186.371,107.144 187.49,106.024 187.49,104.644 C187.49,104.081 187.298,103.567 186.984,103.15 C187.041,103.095 187.097,103.039 187.152,102.982 C187.572,103.303 188.091,103.5 188.66,103.5 C190.041,103.5 191.16,102.381 191.16,101 C191.16,99.961 190.525,99.07 189.623,98.693 C189.644,98.619 189.661,98.543 189.681,98.468 C189.786,98.481 189.891,98.5 190,98.5" id="Fill-9" fill="#3ECC5F"></path>
|
||||||
|
<path d="M60,38.5 C58.619,38.5 57.5,37.381 57.5,36 C57.5,31.864 54.136,28.5 50,28.5 C45.864,28.5 42.5,31.864 42.5,36 C42.5,37.381 41.381,38.5 40,38.5 C38.619,38.5 37.5,37.381 37.5,36 C37.5,29.107 43.107,23.5 50,23.5 C56.893,23.5 62.5,29.107 62.5,36 C62.5,37.381 61.381,38.5 60,38.5" id="Fill-10" fill="#009B2C" opacity="0.5"></path>
|
||||||
|
<path d="M100,166 L160,166 C171.046,166 180,157.046 180,146 L180,76 L120,76 C108.954,76 100,84.954 100,96 L100,166 Z" id="Fill-11" fill="#009B2C" opacity="0.5"></path>
|
||||||
|
<path d="M165.0195,107 L114.9805,107 C114.4275,107 113.9805,106.553 113.9805,106 C113.9805,105.447 114.4275,105 114.9805,105 L165.0195,105 C165.5725,105 166.0195,105.447 166.0195,106 C166.0195,106.553 165.5725,107 165.0195,107" id="Fill-12" fill="#3ECC5F"></path>
|
||||||
|
<path d="M165.0195,127 L114.9805,127 C114.4275,127 113.9805,126.553 113.9805,126 C113.9805,125.447 114.4275,125 114.9805,125 L165.0195,125 C165.5725,125 166.0195,125.447 166.0195,126 C166.0195,126.553 165.5725,127 165.0195,127" id="Fill-13" fill="#3ECC5F"></path>
|
||||||
|
<path d="M165.0195,147 L114.9805,147 C114.4275,147 113.9805,146.553 113.9805,146 C113.9805,145.447 114.4275,145 114.9805,145 L165.0195,145 C165.5725,145 166.0195,145.447 166.0195,146 C166.0195,146.553 165.5725,147 165.0195,147" id="Fill-14" fill="#3ECC5F"></path>
|
||||||
|
<path d="M165.0195,97.1855 L114.9805,97.1855 C114.4275,97.1855 113.9805,96.7375 113.9805,96.1855 C113.9805,95.6325 114.4275,95.1855 114.9805,95.1855 L165.0195,95.1855 C165.5725,95.1855 166.0195,95.6325 166.0195,96.1855 C166.0195,96.7375 165.5725,97.1855 165.0195,97.1855" id="Fill-15" fill="#3ECC5F"></path>
|
||||||
|
<path d="M165.0195,117 L114.9805,117 C114.4275,117 113.9805,116.553 113.9805,116 C113.9805,115.447 114.4275,115 114.9805,115 L165.0195,115 C165.5725,115 166.0195,115.447 166.0195,116 C166.0195,116.553 165.5725,117 165.0195,117" id="Fill-16" fill="#3ECC5F"></path>
|
||||||
|
<path d="M165.0195,137 L114.9805,137 C114.4275,137 113.9805,136.553 113.9805,136 C113.9805,135.447 114.4275,135 114.9805,135 L165.0195,135 C165.5725,135 166.0195,135.447 166.0195,136 C166.0195,136.553 165.5725,137 165.0195,137" id="Fill-17" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-18" fill="#3ECC5F" points="80 166 120 166 120 126 80 126"></polygon>
|
||||||
|
<path d="M140,141 C139.781,141 139.572,141.037 139.361,141.064 C139.323,140.914 139.287,140.763 139.245,140.613 C141.051,139.859 142.32,138.079 142.32,136 C142.32,133.238 140.082,131 137.32,131 C136.182,131 135.145,131.396 134.304,132.036 C134.193,131.923 134.082,131.811 133.969,131.7 C134.596,130.864 134.98,129.838 134.98,128.713 C134.98,125.951 132.742,123.713 129.98,123.713 C127.915,123.713 126.143,124.966 125.381,126.754 C125.233,126.712 125.084,126.677 124.936,126.639 C124.963,126.428 125,126.219 125,126 C125,123.238 122.762,121 120,121 C117.238,121 115,123.238 115,126 C115,126.219 115.037,126.428 115.064,126.639 C114.916,126.677 114.767,126.712 114.619,126.754 C113.857,124.966 112.085,123.713 110.02,123.713 C107.258,123.713 105.02,125.951 105.02,128.713 C105.02,129.838 105.404,130.864 106.031,131.7 C102.314,135.332 100,140.393 100,146 C100,157.046 108.954,166 120,166 C129.339,166 137.16,159.59 139.361,150.936 C139.572,150.963 139.781,151 140,151 C142.762,151 145,148.762 145,146 C145,143.238 142.762,141 140,141" id="Fill-19" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-20" fill="#3ECC5F" points="80 106 120 106 120 86 80 86"></polygon>
|
||||||
|
<path d="M130,98.5 C131.381,98.5 132.5,97.381 132.5,96 C132.5,94.619 131.381,93.5 130,93.5 C129.891,93.5 129.786,93.519 129.681,93.532 C129.661,93.457 129.644,93.382 129.623,93.307 C130.525,92.93 131.16,92.039 131.16,91 C131.16,89.619 130.041,88.5 128.66,88.5 C128.091,88.5 127.572,88.697 127.152,89.018 C127.097,88.961 127.041,88.905 126.984,88.85 C127.298,88.433 127.49,87.919 127.49,87.356 C127.49,85.976 126.371,84.856 124.99,84.856 C123.957,84.856 123.071,85.483 122.69,86.377 C121.833,86.138 120.934,86 120,86 C114.478,86 110,90.478 110,96 C110,101.522 114.478,106 120,106 C120.934,106 121.833,105.862 122.69,105.623 C123.071,106.517 123.957,107.144 124.99,107.144 C126.371,107.144 127.49,106.024 127.49,104.644 C127.49,104.081 127.298,103.567 126.984,103.15 C127.041,103.095 127.097,103.039 127.152,102.982 C127.572,103.303 128.091,103.5 128.66,103.5 C130.041,103.5 131.16,102.381 131.16,101 C131.16,99.961 130.525,99.07 129.623,98.693 C129.644,98.619 129.661,98.543 129.681,98.468 C129.786,98.481 129.891,98.5 130,98.5" id="Fill-21" fill="#3ECC5F"></path>
|
||||||
|
<path d="M140,24.75 C139.84,24.75 139.67,24.73 139.51,24.7 C139.35,24.67 139.189,24.62 139.04,24.56 C138.89,24.5 138.75,24.42 138.609,24.33 C138.479,24.24 138.35,24.13 138.229,24.02 C138.12,23.9 138.01,23.78 137.92,23.64 C137.83,23.5 137.75,23.36 137.689,23.21 C137.63,23.06 137.58,22.9 137.55,22.74 C137.52,22.58 137.5,22.41 137.5,22.25 C137.5,22.09 137.52,21.92 137.55,21.76 C137.58,21.6 137.63,21.45 137.689,21.29 C137.75,21.14 137.83,21 137.92,20.86 C138.01,20.73 138.12,20.6 138.229,20.48 C138.35,20.37 138.479,20.26 138.609,20.17 C138.75,20.08 138.89,20 139.04,19.94 C139.189,19.88 139.35,19.83 139.51,19.8 C139.83,19.73 140.16,19.73 140.49,19.8 C140.649,19.83 140.81,19.88 140.96,19.94 C141.109,20 141.25,20.08 141.39,20.17 C141.52,20.26 141.649,20.37 141.77,20.48 C141.88,20.6 141.99,20.73 142.08,20.86 C142.17,21 142.25,21.14 142.31,21.29 C142.37,21.45 142.42,21.6 142.45,21.76 C142.479,21.92 142.5,22.09 142.5,22.25 C142.5,22.91 142.229,23.56 141.77,24.02 C141.649,24.13 141.52,24.24 141.39,24.33 C141.25,24.42 141.109,24.5 140.96,24.56 C140.81,24.62 140.649,24.67 140.49,24.7 C140.33,24.73 140.16,24.75 140,24.75" id="Fill-22" fill="#009B2C" opacity="0.5"></path>
|
||||||
|
<path d="M160,23.5 C159.34,23.5 158.7,23.23 158.229,22.77 C158.12,22.65 158.01,22.52 157.92,22.39 C157.83,22.25 157.75,22.11 157.689,21.96 C157.63,21.81 157.58,21.65 157.55,21.49 C157.52,21.33 157.5,21.16 157.5,21 C157.5,20.34 157.77,19.7 158.229,19.23 C158.35,19.12 158.479,19.01 158.609,18.92 C158.75,18.83 158.89,18.75 159.04,18.69 C159.189,18.63 159.35,18.58 159.51,18.55 C159.83,18.48 160.17,18.48 160.49,18.55 C160.649,18.58 160.81,18.63 160.96,18.69 C161.109,18.75 161.25,18.83 161.39,18.92 C161.52,19.01 161.649,19.12 161.77,19.23 C162.229,19.7 162.5,20.34 162.5,21 C162.5,21.16 162.479,21.33 162.45,21.49 C162.42,21.65 162.37,21.81 162.31,21.96 C162.24,22.11 162.17,22.25 162.08,22.39 C161.99,22.52 161.88,22.65 161.77,22.77 C161.649,22.88 161.52,22.99 161.39,23.08 C161.25,23.17 161.109,23.25 160.96,23.31 C160.81,23.37 160.649,23.42 160.49,23.45 C160.33,23.48 160.16,23.5 160,23.5" id="Fill-23" fill="#009B2C" opacity="0.5"></path>
|
||||||
|
<path d="M180,44.6113 C179.988,44.6113 179.978,44.6053 179.966,44.6063 C176.876,44.7113 175.414,47.8023 174.124,50.5293 C172.778,53.3783 171.737,55.2323 170.031,55.1763 C168.142,55.1083 167.062,52.9743 165.918,50.7153 C164.604,48.1223 163.104,45.1803 159.955,45.2903 C156.909,45.3943 155.442,48.0843 154.148,50.4573 C152.771,52.9853 151.834,54.5223 150.027,54.4513 C148.1,54.3813 147.076,52.6463 145.891,50.6383 C144.57,48.4023 143.043,45.8883 139.955,45.9743 C136.961,46.0773 135.49,48.3593 134.192,50.3743 C132.819,52.5043 131.857,53.8023 130.027,53.7253 C128.054,53.6543 127.035,52.2153 125.856,50.5483 C124.532,48.6753 123.04,46.5553 119.961,46.6583 C117.033,46.7583 115.562,48.6273 114.265,50.2763 C113.033,51.8403 112.071,53.0783 110.036,53.0003 C109.484,52.9783 109.021,53.4113 109.001,53.9643 C108.98,54.5153 109.412,54.9793 109.964,55.0003 C112.981,55.1013 114.509,53.1993 115.836,51.5133 C117.013,50.0173 118.029,48.7263 120.029,48.6583 C121.955,48.5763 122.858,49.7733 124.224,51.7033 C125.521,53.5373 126.993,55.6173 129.955,55.7243 C133.058,55.8283 134.551,53.5093 135.873,51.4573 C137.055,49.6233 138.075,48.0403 140.023,47.9733 C141.816,47.9063 142.792,49.3233 144.168,51.6543 C145.465,53.8513 146.934,56.3403 149.955,56.4503 C153.08,56.5583 154.589,53.8293 155.904,51.4153 C157.043,49.3273 158.118,47.3543 160.023,47.2893 C161.816,47.2473 162.751,48.8843 164.134,51.6193 C165.426,54.1723 166.891,57.0643 169.959,57.1753 C170.016,57.1773 170.072,57.1783 170.128,57.1783 C173.192,57.1783 174.646,54.1033 175.933,51.3843 C177.072,48.9743 178.15,46.7033 180,46.6113 L180,44.6113 Z" id="Fill-24" fill="#009B2C" opacity="0.5"></path>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 13 KiB |
61
img/docusaurus_speed.svg
Normal file
61
img/docusaurus_speed.svg
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="250px" height="200px" viewBox="0 0 250 200" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
|
||||||
|
<title>docusaurus_speed</title>
|
||||||
|
<desc>Created with Sketch.</desc>
|
||||||
|
<defs></defs>
|
||||||
|
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||||
|
<g id="docusaurus_speed">
|
||||||
|
<g id="Group" transform="translate(3.000000, 13.000000)">
|
||||||
|
<g id="Group-3" opacity="0.360903533" transform="translate(20.000000, 0.000000)">
|
||||||
|
<path d="M20,150 C12.602,150 6.157,145.973 2.697,140 C0.992,142.944 0,146.353 0,150 C0,161.046 8.954,170 20,170 L40,170 L40,150 L20,150 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<path d="M109.9805,44.376 L180.0005,40 L180.0005,30 C180.0005,18.954 171.0455,10 160.0005,10 L70.0005,10 L67.5005,5.67 C66.3885,3.745 63.6115,3.745 62.5005,5.67 L60.0005,10 L57.5005,5.67 C56.3885,3.745 53.6115,3.745 52.5005,5.67 L50.0005,10 L47.5005,5.67 C46.3885,3.745 43.6115,3.745 42.5005,5.67 L40.0005,10 C39.9785,10 39.9575,10.003 39.9355,10.003 L35.7935,5.862 C34.2225,4.291 31.5405,5.009 30.9645,7.156 L29.5965,12.26 L24.4035,10.868 C22.2565,10.293 20.2925,12.257 20.8685,14.404 L22.2595,19.597 L17.1565,20.964 C15.0095,21.54 14.2905,24.223 15.8615,25.794 L20.0025,29.936 C20.0025,29.957 20.0005,29.978 20.0005,30 L15.6695,32.5 C13.7455,33.611 13.7455,36.389 15.6695,37.5 L20.0005,40 L15.6695,42.5 C13.7455,43.611 13.7455,46.389 15.6695,47.5 L20.0005,50 L15.6695,52.5 C13.7455,53.611 13.7455,56.389 15.6695,57.5 L20.0005,60 L15.6695,62.5 C13.7455,63.611 13.7455,66.389 15.6695,67.5 L20.0005,70 L15.6695,72.5 C13.7455,73.611 13.7455,76.389 15.6695,77.5 L20.0005,80 L15.6695,82.5 C13.7455,83.611 13.7455,86.389 15.6695,87.5 L20.0005,90 L15.6695,92.5 C13.7455,93.611 13.7455,96.389 15.6695,97.5 L20.0005,100 L15.6695,102.5 C13.7455,103.611 13.7455,106.389 15.6695,107.5 L20.0005,110 L15.6695,112.5 C13.7455,113.611 13.7455,116.389 15.6695,117.5 L20.0005,120 L15.6695,122.5 C13.7455,123.611 13.7455,126.389 15.6695,127.5 L20.0005,130 L15.6695,132.5 C13.7455,133.611 13.7455,136.389 15.6695,137.5 L20.0005,140 L15.6695,142.5 C13.7455,143.611 13.7455,146.389 15.6695,147.5 L20.0005,150 C20.0005,161.046 28.9545,170 40.0005,170 L160.0005,170 C171.0455,170 180.0005,161.046 180.0005,150 L180.0005,70 L109.9805,65.624 C104.3705,65.273 100.0005,60.621 100.0005,55 C100.0005,49.379 104.3705,44.727 109.9805,44.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<path d="M180.0005,40 L180.0005,20 C180.0005,8.954 171.0455,0 160.0005,0 L44.1119504,0 L44.1119504,2.74303957e-09 C27.5881854,2.74305728e-09 14.1753483,13.3616508 14.1121697,29.8852951 C13.9910418,61.5649477 14.0373107,77.4664639 14.2509766,77.5898438 L180.0005,77.5898438 L180.0005,70 L180.0005,40 Z" id="Fill-3" fill="#D0021B"></path>
|
||||||
|
</g>
|
||||||
|
<g id="Group-3" opacity="0.360903533">
|
||||||
|
<path d="M20,150 C12.602,150 6.157,145.973 2.697,140 C0.992,142.944 0,146.353 0,150 C0,161.046 8.954,170 20,170 L40,170 L40,150 L20,150 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<path d="M109.9805,44.376 L180.0005,40 L180.0005,30 C180.0005,18.954 171.0455,10 160.0005,10 L70.0005,10 L67.5005,5.67 C66.3885,3.745 63.6115,3.745 62.5005,5.67 L60.0005,10 L57.5005,5.67 C56.3885,3.745 53.6115,3.745 52.5005,5.67 L50.0005,10 L47.5005,5.67 C46.3885,3.745 43.6115,3.745 42.5005,5.67 L40.0005,10 C39.9785,10 39.9575,10.003 39.9355,10.003 L35.7935,5.862 C34.2225,4.291 31.5405,5.009 30.9645,7.156 L29.5965,12.26 L24.4035,10.868 C22.2565,10.293 20.2925,12.257 20.8685,14.404 L22.2595,19.597 L17.1565,20.964 C15.0095,21.54 14.2905,24.223 15.8615,25.794 L20.0025,29.936 C20.0025,29.957 20.0005,29.978 20.0005,30 L15.6695,32.5 C13.7455,33.611 13.7455,36.389 15.6695,37.5 L20.0005,40 L15.6695,42.5 C13.7455,43.611 13.7455,46.389 15.6695,47.5 L20.0005,50 L15.6695,52.5 C13.7455,53.611 13.7455,56.389 15.6695,57.5 L20.0005,60 L15.6695,62.5 C13.7455,63.611 13.7455,66.389 15.6695,67.5 L20.0005,70 L15.6695,72.5 C13.7455,73.611 13.7455,76.389 15.6695,77.5 L20.0005,80 L15.6695,82.5 C13.7455,83.611 13.7455,86.389 15.6695,87.5 L20.0005,90 L15.6695,92.5 C13.7455,93.611 13.7455,96.389 15.6695,97.5 L20.0005,100 L15.6695,102.5 C13.7455,103.611 13.7455,106.389 15.6695,107.5 L20.0005,110 L15.6695,112.5 C13.7455,113.611 13.7455,116.389 15.6695,117.5 L20.0005,120 L15.6695,122.5 C13.7455,123.611 13.7455,126.389 15.6695,127.5 L20.0005,130 L15.6695,132.5 C13.7455,133.611 13.7455,136.389 15.6695,137.5 L20.0005,140 L15.6695,142.5 C13.7455,143.611 13.7455,146.389 15.6695,147.5 L20.0005,150 C20.0005,161.046 28.9545,170 40.0005,170 L160.0005,170 C171.0455,170 180.0005,161.046 180.0005,150 L180.0005,70 L109.9805,65.624 C104.3705,65.273 100.0005,60.621 100.0005,55 C100.0005,49.379 104.3705,44.727 109.9805,44.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<path d="M180.0005,40 L180.0005,20 C180.0005,8.954 171.0455,0 160.0005,0 L44.1119504,0 L44.1119504,2.74303957e-09 C27.5881854,2.74305728e-09 14.1753483,13.3616508 14.1121697,29.8852951 C13.9910418,61.5649477 14.0373107,77.4664639 14.2509766,77.5898438 L180.0005,77.5898438 L180.0005,70 L180.0005,40 Z" id="Fill-3" fill="#D0021B"></path>
|
||||||
|
</g>
|
||||||
|
<rect id="Rectangle" fill="#FFFFFF" x="136" y="39" width="84" height="34"></rect>
|
||||||
|
<g id="Group-2" transform="translate(40.000000, 4.000000)">
|
||||||
|
<path d="M20,146 C12.602,146 6.157,141.973 2.697,136 C0.992,138.944 0,142.353 0,146 C0,157.046 8.954,166 20,166 L40,166 L40,146 L20,146 Z" id="Fill-1" fill="#3ECC5F"></path>
|
||||||
|
<path d="M109.9805,40.376 L180.0005,36 L180.0005,26 C180.0005,14.954 171.0455,6 160.0005,6 L70.0005,6 L67.5005,1.67 C66.3885,-0.255 63.6115,-0.255 62.5005,1.67 L60.0005,6 L57.5005,1.67 C56.3885,-0.255 53.6115,-0.255 52.5005,1.67 L50.0005,6 L47.5005,1.67 C46.3885,-0.255 43.6115,-0.255 42.5005,1.67 L40.0005,6 C39.9785,6 39.9575,6.003 39.9355,6.003 L35.7935,1.862 C34.2225,0.291 31.5405,1.009 30.9645,3.156 L29.5965,8.26 L24.4035,6.868 C22.2565,6.293 20.2925,8.257 20.8685,10.404 L22.2595,15.597 L17.1565,16.964 C15.0095,17.54 14.2905,20.223 15.8615,21.794 L20.0025,25.936 C20.0025,25.957 20.0005,25.978 20.0005,26 L15.6695,28.5 C13.7455,29.611 13.7455,32.389 15.6695,33.5 L20.0005,36 L15.6695,38.5 C13.7455,39.611 13.7455,42.389 15.6695,43.5 L20.0005,46 L15.6695,48.5 C13.7455,49.611 13.7455,52.389 15.6695,53.5 L20.0005,56 L15.6695,58.5 C13.7455,59.611 13.7455,62.389 15.6695,63.5 L20.0005,66 L15.6695,68.5 C13.7455,69.611 13.7455,72.389 15.6695,73.5 L20.0005,76 L15.6695,78.5 C13.7455,79.611 13.7455,82.389 15.6695,83.5 L20.0005,86 L15.6695,88.5 C13.7455,89.611 13.7455,92.389 15.6695,93.5 L20.0005,96 L15.6695,98.5 C13.7455,99.611 13.7455,102.389 15.6695,103.5 L20.0005,106 L15.6695,108.5 C13.7455,109.611 13.7455,112.389 15.6695,113.5 L20.0005,116 L15.6695,118.5 C13.7455,119.611 13.7455,122.389 15.6695,123.5 L20.0005,126 L15.6695,128.5 C13.7455,129.611 13.7455,132.389 15.6695,133.5 L20.0005,136 L15.6695,138.5 C13.7455,139.611 13.7455,142.389 15.6695,143.5 L20.0005,146 C20.0005,157.046 28.9545,166 40.0005,166 L160.0005,166 C171.0455,166 180.0005,157.046 180.0005,146 L180.0005,66 L109.9805,61.624 C104.3705,61.273 100.0005,56.621 100.0005,51 C100.0005,45.379 104.3705,40.727 109.9805,40.376" id="Fill-3" fill="#3ECC5F"></path>
|
||||||
|
<polygon id="Fill-5" fill="#3ECC5F" points="140 166 170 166 170 126 140 126"></polygon>
|
||||||
|
<path d="M190,141 C189.781,141 189.572,141.037 189.361,141.064 C189.323,140.914 189.287,140.763 189.245,140.613 C191.051,139.859 192.32,138.079 192.32,136 C192.32,133.238 190.082,131 187.32,131 C186.182,131 185.145,131.396 184.304,132.036 C184.193,131.923 184.082,131.811 183.969,131.7 C184.596,130.864 184.98,129.838 184.98,128.713 C184.98,125.951 182.742,123.713 179.98,123.713 C177.915,123.713 176.143,124.966 175.381,126.754 C175.233,126.712 175.084,126.677 174.936,126.639 C174.963,126.428 175,126.219 175,126 C175,123.238 172.762,121 170,121 C167.238,121 165,123.238 165,126 C165,126.219 165.037,126.428 165.064,126.639 C164.916,126.677 164.767,126.712 164.619,126.754 C163.857,124.966 162.085,123.713 160.02,123.713 C157.258,123.713 155.02,125.951 155.02,128.713 C155.02,129.838 155.404,130.864 156.031,131.7 C152.314,135.332 150,140.393 150,146 C150,157.046 158.954,166 170,166 C179.339,166 187.16,159.59 189.361,150.936 C189.572,150.963 189.781,151 190,151 C192.762,151 195,148.762 195,146 C195,143.238 192.762,141 190,141" id="Fill-7" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-8" fill="#3ECC5F" points="150 106 180 106 180 86 150 86"></polygon>
|
||||||
|
<path d="M190,98.5 C191.381,98.5 192.5,97.381 192.5,96 C192.5,94.619 191.381,93.5 190,93.5 C189.891,93.5 189.786,93.519 189.681,93.532 C189.661,93.457 189.644,93.382 189.623,93.307 C190.525,92.93 191.16,92.039 191.16,91 C191.16,89.619 190.041,88.5 188.66,88.5 C188.091,88.5 187.572,88.697 187.152,89.018 C187.097,88.961 187.041,88.905 186.984,88.85 C187.298,88.433 187.49,87.919 187.49,87.356 C187.49,85.976 186.371,84.856 184.99,84.856 C183.957,84.856 183.071,85.483 182.69,86.377 C181.833,86.138 180.934,86 180,86 C174.478,86 170,90.478 170,96 C170,101.522 174.478,106 180,106 C180.934,106 181.833,105.862 182.69,105.623 C183.071,106.517 183.957,107.144 184.99,107.144 C186.371,107.144 187.49,106.024 187.49,104.644 C187.49,104.081 187.298,103.567 186.984,103.15 C187.041,103.095 187.097,103.039 187.152,102.982 C187.572,103.303 188.091,103.5 188.66,103.5 C190.041,103.5 191.16,102.381 191.16,101 C191.16,99.961 190.525,99.07 189.623,98.693 C189.644,98.619 189.661,98.543 189.681,98.468 C189.786,98.481 189.891,98.5 190,98.5" id="Fill-9" fill="#44D860"></path>
|
||||||
|
<path d="M100,166 L160,166 C171.046,166 180,157.046 180,146 L180,76 L120,76 C108.954,76 100,84.954 100,96 L100,166 Z" id="Fill-11" fill="#FFFF50"></path>
|
||||||
|
<path d="M165.0195,107 L114.9805,107 C114.4275,107 113.9805,106.553 113.9805,106 C113.9805,105.447 114.4275,105 114.9805,105 L165.0195,105 C165.5725,105 166.0195,105.447 166.0195,106 C166.0195,106.553 165.5725,107 165.0195,107" id="Fill-12" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,127 L114.9805,127 C114.4275,127 113.9805,126.553 113.9805,126 C113.9805,125.447 114.4275,125 114.9805,125 L165.0195,125 C165.5725,125 166.0195,125.447 166.0195,126 C166.0195,126.553 165.5725,127 165.0195,127" id="Fill-13" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,147 L114.9805,147 C114.4275,147 113.9805,146.553 113.9805,146 C113.9805,145.447 114.4275,145 114.9805,145 L165.0195,145 C165.5725,145 166.0195,145.447 166.0195,146 C166.0195,146.553 165.5725,147 165.0195,147" id="Fill-14" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,97.1855 L114.9805,97.1855 C114.4275,97.1855 113.9805,96.7375 113.9805,96.1855 C113.9805,95.6325 114.4275,95.1855 114.9805,95.1855 L165.0195,95.1855 C165.5725,95.1855 166.0195,95.6325 166.0195,96.1855 C166.0195,96.7375 165.5725,97.1855 165.0195,97.1855" id="Fill-15" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,117 L114.9805,117 C114.4275,117 113.9805,116.553 113.9805,116 C113.9805,115.447 114.4275,115 114.9805,115 L165.0195,115 C165.5725,115 166.0195,115.447 166.0195,116 C166.0195,116.553 165.5725,117 165.0195,117" id="Fill-16" fill="#000000"></path>
|
||||||
|
<path d="M165.0195,137 L114.9805,137 C114.4275,137 113.9805,136.553 113.9805,136 C113.9805,135.447 114.4275,135 114.9805,135 L165.0195,135 C165.5725,135 166.0195,135.447 166.0195,136 C166.0195,136.553 165.5725,137 165.0195,137" id="Fill-17" fill="#000000"></path>
|
||||||
|
<path d="M180,44.6113 C179.988,44.6113 179.978,44.6053 179.966,44.6063 C176.876,44.7113 175.414,47.8023 174.124,50.5293 C172.778,53.3783 171.737,55.2323 170.031,55.1763 C168.142,55.1083 167.062,52.9743 165.918,50.7153 C164.604,48.1223 163.104,45.1803 159.955,45.2903 C156.909,45.3943 155.442,48.0843 154.148,50.4573 C152.771,52.9853 151.834,54.5223 150.027,54.4513 C148.1,54.3813 147.076,52.6463 145.891,50.6383 C144.57,48.4023 143.043,45.8883 139.955,45.9743 C136.961,46.0773 135.49,48.3593 134.192,50.3743 C132.819,52.5043 131.857,53.8023 130.027,53.7253 C128.054,53.6543 127.035,52.2153 125.856,50.5483 C124.532,48.6753 123.04,46.5553 119.961,46.6583 C117.033,46.7583 115.562,48.6273 114.265,50.2763 C113.033,51.8403 112.071,53.0783 110.036,53.0003 C109.484,52.9783 109.021,53.4113 109.001,53.9643 C108.98,54.5153 109.412,54.9793 109.964,55.0003 C112.981,55.1013 114.509,53.1993 115.836,51.5133 C117.013,50.0173 118.029,48.7263 120.029,48.6583 C121.955,48.5763 122.858,49.7733 124.224,51.7033 C125.521,53.5373 126.993,55.6173 129.955,55.7243 C133.058,55.8283 134.551,53.5093 135.873,51.4573 C137.055,49.6233 138.075,48.0403 140.023,47.9733 C141.816,47.9063 142.792,49.3233 144.168,51.6543 C145.465,53.8513 146.934,56.3403 149.955,56.4503 C153.08,56.5583 154.589,53.8293 155.904,51.4153 C157.043,49.3273 158.118,47.3543 160.023,47.2893 C161.816,47.2473 162.751,48.8843 164.134,51.6193 C165.426,54.1723 166.891,57.0643 169.959,57.1753 C170.016,57.1773 170.072,57.1783 170.128,57.1783 C173.192,57.1783 174.646,54.1033 175.933,51.3843 C177.072,48.9743 178.15,46.7033 180,46.6113 L180,44.6113 Z" id="Fill-24" fill="#000000"></path>
|
||||||
|
<polygon id="Fill-18" fill="#3ECC5F" points="80 166 120 166 120 126 80 126"></polygon>
|
||||||
|
<path d="M181.757775,99 L159,99 L159,167 L154,167 L154,99 L123,99 L123,95 L181.256059,95 C181.873813,93.2522114 183.540672,92 185.5,92 C187.985281,92 190,94.0147186 190,96.5 C190,98.9852814 187.985281,101 185.5,101 C183.939792,101 182.565036,100.205986 181.757775,99 Z" id="Combined-Shape" fill="#D8D8D8"></path>
|
||||||
|
<path d="M140,141 C139.781,141 139.572,141.037 139.361,141.064 C139.323,140.914 139.287,140.763 139.245,140.613 C141.051,139.859 142.32,138.079 142.32,136 C142.32,133.238 140.082,131 137.32,131 C136.182,131 135.145,131.396 134.304,132.036 C134.193,131.923 134.082,131.811 133.969,131.7 C134.596,130.864 134.98,129.838 134.98,128.713 C134.98,125.951 132.742,123.713 129.98,123.713 C127.915,123.713 126.143,124.966 125.381,126.754 C125.233,126.712 125.084,126.677 124.936,126.639 C124.963,126.428 125,126.219 125,126 C125,123.238 122.762,121 120,121 C117.238,121 115,123.238 115,126 C115,126.219 115.037,126.428 115.064,126.639 C114.916,126.677 114.767,126.712 114.619,126.754 C113.857,124.966 112.085,123.713 110.02,123.713 C107.258,123.713 105.02,125.951 105.02,128.713 C105.02,129.838 105.404,130.864 106.031,131.7 C102.314,135.332 100,140.393 100,146 C100,157.046 108.954,166 120,166 C129.339,166 137.16,159.59 139.361,150.936 C139.572,150.963 139.781,151 140,151 C142.762,151 145,148.762 145,146 C145,143.238 142.762,141 140,141" id="Fill-19" fill="#44D860"></path>
|
||||||
|
<polygon id="Fill-20" fill="#3ECC5F" points="80 106 120 106 120 86 80 86"></polygon>
|
||||||
|
<path d="M130,98.5 C131.381,98.5 132.5,97.381 132.5,96 C132.5,94.619 131.381,93.5 130,93.5 C129.891,93.5 129.786,93.519 129.681,93.532 C129.661,93.457 129.644,93.382 129.623,93.307 C130.525,92.93 131.16,92.039 131.16,91 C131.16,89.619 130.041,88.5 128.66,88.5 C128.091,88.5 127.572,88.697 127.152,89.018 C127.097,88.961 127.041,88.905 126.984,88.85 C127.298,88.433 127.49,87.919 127.49,87.356 C127.49,85.976 126.371,84.856 124.99,84.856 C123.957,84.856 123.071,85.483 122.69,86.377 C121.833,86.138 120.934,86 120,86 C114.478,86 110,90.478 110,96 C110,101.522 114.478,106 120,106 C120.934,106 121.833,105.862 122.69,105.623 C123.071,106.517 123.957,107.144 124.99,107.144 C126.371,107.144 127.49,106.024 127.49,104.644 C127.49,104.081 127.298,103.567 126.984,103.15 C127.041,103.095 127.097,103.039 127.152,102.982 C127.572,103.303 128.091,103.5 128.66,103.5 C130.041,103.5 131.16,102.381 131.16,101 C131.16,99.961 130.525,99.07 129.623,98.693 C129.644,98.619 129.661,98.543 129.681,98.468 C129.786,98.481 129.891,98.5 130,98.5" id="Fill-21" fill="#44D860"></path>
|
||||||
|
<path d="M140,24.75 C139.84,24.75 139.67,24.73 139.51,24.7 C139.35,24.67 139.189,24.62 139.04,24.56 C138.89,24.5 138.75,24.42 138.609,24.33 C138.479,24.24 138.35,24.13 138.229,24.02 C138.12,23.9 138.01,23.78 137.92,23.64 C137.83,23.5 137.75,23.36 137.689,23.21 C137.63,23.06 137.58,22.9 137.55,22.74 C137.52,22.58 137.5,22.41 137.5,22.25 C137.5,22.09 137.52,21.92 137.55,21.76 C137.58,21.6 137.63,21.45 137.689,21.29 C137.75,21.14 137.83,21 137.92,20.86 C138.01,20.73 138.12,20.6 138.229,20.48 C138.35,20.37 138.479,20.26 138.609,20.17 C138.75,20.08 138.89,20 139.04,19.94 C139.189,19.88 139.35,19.83 139.51,19.8 C139.83,19.73 140.16,19.73 140.49,19.8 C140.649,19.83 140.81,19.88 140.96,19.94 C141.109,20 141.25,20.08 141.39,20.17 C141.52,20.26 141.649,20.37 141.77,20.48 C141.88,20.6 141.99,20.73 142.08,20.86 C142.17,21 142.25,21.14 142.31,21.29 C142.37,21.45 142.42,21.6 142.45,21.76 C142.479,21.92 142.5,22.09 142.5,22.25 C142.5,22.91 142.229,23.56 141.77,24.02 C141.649,24.13 141.52,24.24 141.39,24.33 C141.25,24.42 141.109,24.5 140.96,24.56 C140.81,24.62 140.649,24.67 140.49,24.7 C140.33,24.73 140.16,24.75 140,24.75" id="Fill-22" fill="#000000"></path>
|
||||||
|
<path d="M160,23.5 C159.34,23.5 158.7,23.23 158.229,22.77 C158.12,22.65 158.01,22.52 157.92,22.39 C157.83,22.25 157.75,22.11 157.689,21.96 C157.63,21.81 157.58,21.65 157.55,21.49 C157.52,21.33 157.5,21.16 157.5,21 C157.5,20.34 157.77,19.7 158.229,19.23 C158.35,19.12 158.479,19.01 158.609,18.92 C158.75,18.83 158.89,18.75 159.04,18.69 C159.189,18.63 159.35,18.58 159.51,18.55 C159.83,18.48 160.17,18.48 160.49,18.55 C160.649,18.58 160.81,18.63 160.96,18.69 C161.109,18.75 161.25,18.83 161.39,18.92 C161.52,19.01 161.649,19.12 161.77,19.23 C162.229,19.7 162.5,20.34 162.5,21 C162.5,21.16 162.479,21.33 162.45,21.49 C162.42,21.65 162.37,21.81 162.31,21.96 C162.24,22.11 162.17,22.25 162.08,22.39 C161.99,22.52 161.88,22.65 161.77,22.77 C161.649,22.88 161.52,22.99 161.39,23.08 C161.25,23.17 161.109,23.25 160.96,23.31 C160.81,23.37 160.649,23.42 160.49,23.45 C160.33,23.48 160.16,23.5 160,23.5" id="Fill-23" fill="#000000"></path>
|
||||||
|
</g>
|
||||||
|
<path d="M220.0005,40 L220.0005,20 C220.0005,8.954 211.0455,0 200.0005,0 L84.1119504,0 L84.1119504,2.74303957e-09 C67.5881854,2.74305728e-09 54.1753483,13.3616508 54.1121697,29.8852951 C53.9910418,61.5649477 54.0373107,77.4664639 54.2509766,77.5898438 L220.0005,77.5898438 L220.0005,70 L220.0005,40 Z" id="Fill-3" fill="#D0021B"></path>
|
||||||
|
<path d="M92,19 L219.967773,19 L219.967773,66.8251953 L72,66.8251953 L72,39 L72,39 C72,27.954305 80.954305,19 92,19 Z" id="Rectangle-2" fill="#000000"></path>
|
||||||
|
<path d="M100,42.5 C98.619,42.5 97.5,41.381 97.5,40 C97.5,35.864 94.136,32.5 90,32.5 C85.864,32.5 82.5,35.864 82.5,40 C82.5,41.381 81.381,42.5 80,42.5 C78.619,42.5 77.5,41.381 77.5,40 C77.5,33.107 83.107,27.5 90,27.5 C96.893,27.5 102.5,33.107 102.5,40 C102.5,41.381 101.381,42.5 100,42.5" id="Fill-10" fill="#9B9B9B" opacity="0.545572917"></path>
|
||||||
|
<rect id="Rectangle-3" fill="#D8D8D8" opacity="0.435575181" x="209" y="22" width="8" height="19"></rect>
|
||||||
|
<path d="M198,4 L203.335283,3.71946003 L203.335283,3.71946003 C210.50508,3.3424576 216.622969,8.84910546 216.999972,16.0189023 C217.011926,16.2462471 217.017906,16.4738667 217.017906,16.7015256 L217.017906,17.0175781 L208.968101,17.0175781 L208.968101,13.9532118 L208.968101,13.9532118 C208.968101,8.43036433 204.490949,3.95321183 198.968101,3.95321183 C198.664975,3.95321183 198.362006,3.96699462 198.060132,3.99451751 L198,4 Z" id="Rectangle-5" fill="#D8D8D8" opacity="0.537760417"></path>
|
||||||
|
<rect id="Rectangle-4" fill="#D8D8D8" opacity="0.435575181" x="209" y="43" width="8" height="4"></rect>
|
||||||
|
</g>
|
||||||
|
<ellipse id="Oval" fill="#930012" transform="translate(93.500000, 28.000000) rotate(-20.000000) translate(-93.500000, -28.000000) " cx="93.5" cy="28" rx="3.5" ry="1"></ellipse>
|
||||||
|
<path d="M94.5,26 C94.5,21.0294373 90.6944204,17 86,17" id="Oval-2" stroke="#6D000D" opacity="0.620301178" transform="translate(90.250000, 21.500000) rotate(-15.000000) translate(-90.250000, -21.500000) "></path>
|
||||||
|
<path d="M87.5,30 C87.5,25.0294373 83.6944204,21 79,21" id="Oval-2" stroke="#6D000D" opacity="0.620301178" transform="translate(83.250000, 25.500000) rotate(-15.000000) translate(-83.250000, -25.500000) "></path>
|
||||||
|
<rect id="Rectangle-7" fill="#D8D8D8" x="74" y="184" width="135" height="3"></rect>
|
||||||
|
<circle id="Oval-3" fill="#000000" cx="209.5" cy="186.5" r="6.5"></circle>
|
||||||
|
<circle id="Oval-3" fill="#000000" cx="71.5" cy="186.5" r="6.5"></circle>
|
||||||
|
<circle id="Oval-5" fill="#4A4A4A" cx="209.5" cy="186.5" r="2.5"></circle>
|
||||||
|
<circle id="Oval-5" fill="#4A4A4A" cx="71.5" cy="186.5" r="2.5"></circle>
|
||||||
|
</g>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 21 KiB |
BIN
img/fasttext.png
Normal file
BIN
img/fasttext.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.3 KiB |
BIN
img/favicon.png
Normal file
BIN
img/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 984 B |
BIN
img/favicon/favicon.ico
Normal file
BIN
img/favicon/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
1
img/frank.svg
Normal file
1
img/frank.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 76 KiB |
3
img/language.svg
Normal file
3
img/language.svg
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<svg class="language {{include.class}}" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
|
||||||
|
<path fill="#ffffff" d="M19.753 10.909c-.624-1.707-2.366-2.726-4.661-2.726-.09 0-.176.002-.262.006l-.016-2.063 3.525-.607c.115-.019.133-.119.109-.231-.023-.111-.167-.883-.188-.976-.027-.131-.102-.127-.207-.109-.104.018-3.25.461-3.25.461l-.013-2.078c-.001-.125-.069-.158-.194-.156l-1.025.016c-.105.002-.164.049-.162.148l.033 2.307s-3.061.527-3.144.543c-.084.014-.17.053-.151.143.019.09.19 1.094.208 1.172.018.08.072.129.188.107l2.924-.504.035 2.018c-1.077.281-1.801.824-2.256 1.303-.768.807-1.207 1.887-1.207 2.963 0 1.586.971 2.529 2.328 2.695 3.162.387 5.119-3.06 5.769-4.715 1.097 1.506.256 4.354-2.094 5.98-.043.029-.098.129-.033.207l.619.756c.08.096.206.059.256.023 2.51-1.73 3.661-4.515 2.869-6.683zm-7.386 3.188c-.966-.121-.944-.914-.944-1.453 0-.773.327-1.58.876-2.156a3.21 3.21 0 0 1 1.229-.799l.082 4.277a2.773 2.773 0 0 1-1.243.131zm2.427-.553l.046-4.109c.084-.004.166-.01.252-.01.773 0 1.494.145 1.885.361.391.217-1.023 2.713-2.183 3.758zm-8.95-7.668a.196.196 0 0 0-.196-.145h-1.95a.194.194 0 0 0-.194.144L.008 16.916c-.017.051-.011.076.062.076h1.733c.075 0 .099-.023.114-.072l1.008-3.318h3.496l1.008 3.318c.016.049.039.072.113.072h1.734c.072 0 .078-.025.062-.076-.014-.05-3.083-9.741-3.494-11.04zm-2.618 6.318l1.447-5.25 1.447 5.25H3.226z"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
BIN
img/markdown.png
Normal file
BIN
img/markdown.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.9 KiB |
BIN
img/oss_logo.png
Normal file
BIN
img/oss_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.3 KiB |
BIN
img/prettier.png
Normal file
BIN
img/prettier.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.5 KiB |
21
img/react.svg
Normal file
21
img/react.svg
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||||
|
<svg version="1.1" id="Layer_2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||||
|
width="600px" height="600px" viewBox="0 0 600 600" enable-background="new 0 0 600 600" xml:space="preserve">
|
||||||
|
<rect fill="none" width="600" height="600"/>
|
||||||
|
<circle fill="#00D8FF" cx="299.529" cy="299.628" r="50.167"/>
|
||||||
|
<path fill="none" stroke="#00D8FF" stroke-width="24" stroke-miterlimit="10" d="M299.529,197.628
|
||||||
|
c67.356,0,129.928,9.665,177.107,25.907c56.844,19.569,91.794,49.233,91.794,76.093c0,27.991-37.041,59.503-98.083,79.728
|
||||||
|
c-46.151,15.291-106.879,23.272-170.818,23.272c-65.554,0-127.63-7.492-174.29-23.441c-59.046-20.182-94.611-52.103-94.611-79.559
|
||||||
|
c0-26.642,33.37-56.076,89.415-75.616C167.398,207.503,231.515,197.628,299.529,197.628z"/>
|
||||||
|
<path fill="none" stroke="#00D8FF" stroke-width="24" stroke-miterlimit="10" d="M210.736,248.922
|
||||||
|
c33.649-58.348,73.281-107.724,110.92-140.48c45.35-39.466,88.507-54.923,111.775-41.505
|
||||||
|
c24.248,13.983,33.042,61.814,20.067,124.796c-9.81,47.618-33.234,104.212-65.176,159.601
|
||||||
|
c-32.749,56.788-70.25,106.819-107.377,139.272c-46.981,41.068-92.4,55.929-116.185,42.213
|
||||||
|
c-23.079-13.31-31.906-56.921-20.834-115.233C153.281,368.316,176.758,307.841,210.736,248.922z"/>
|
||||||
|
<path fill="none" stroke="#00D8FF" stroke-width="24" stroke-miterlimit="10" d="M210.821,351.482
|
||||||
|
c-33.746-58.292-56.731-117.287-66.312-166.255c-11.544-58.999-3.382-104.109,19.864-117.566
|
||||||
|
c24.224-14.024,70.055,2.244,118.14,44.94c36.356,32.28,73.688,80.837,105.723,136.173c32.844,56.733,57.461,114.209,67.036,162.582
|
||||||
|
c12.117,61.213,2.309,107.984-21.453,121.74c-23.057,13.348-65.249-0.784-110.239-39.499
|
||||||
|
C285.567,460.886,244.898,410.344,210.821,351.482z"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.8 KiB |
5
img/search.svg
Normal file
5
img/search.svg
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<svg width="50" height="50" version="1.1" viewBox="0 0 50.000001 50.000001" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<rect width="50" height="50" fill-opacity="0"/>
|
||||||
|
<path d="m18.623 4.2559c-7.9132 0-14.367 6.454-14.367 14.367 0 7.9132 6.454 14.367 14.367 14.367 3.2414 0 6.2283-1.0954 8.6367-2.918a2.0002 2.0002 0 0 0 0.15039 0.16602l14.898 14.898a2.0002 2.0002 0 1 0 2.8281 -2.8281l-14.898-14.898a2.0002 2.0002 0 0 0 -0.16602 -0.15039c1.8225-2.4084 2.918-5.3953 2.918-8.6367 0-7.9132-6.454-14.367-14.367-14.367zm0 3.5898c5.9732 0 10.777 4.8042 10.777 10.777 0 5.9732-4.8042 10.777-10.777 10.777s-10.777-4.8042-10.777-10.777c2e-7 -5.9732 4.8042-10.777 10.777-10.777z" color="#000000" color-rendering="auto" fill="#555" image-rendering="auto" shape-rendering="auto" solid-color="#000000" style="block-progression:tb;isolation:auto;mix-blend-mode:normal;text-decoration-color:#000000;text-decoration-line:none;text-decoration-style:solid;text-indent:0;text-transform:none;white-space:normal"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1 KiB |
3
img/translation.svg
Normal file
3
img/translation.svg
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
<svg class="language {{include.class}}" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
|
||||||
|
<path fill="#000000" d="M19.753 10.909c-.624-1.707-2.366-2.726-4.661-2.726-.09 0-.176.002-.262.006l-.016-2.063 3.525-.607c.115-.019.133-.119.109-.231-.023-.111-.167-.883-.188-.976-.027-.131-.102-.127-.207-.109-.104.018-3.25.461-3.25.461l-.013-2.078c-.001-.125-.069-.158-.194-.156l-1.025.016c-.105.002-.164.049-.162.148l.033 2.307s-3.061.527-3.144.543c-.084.014-.17.053-.151.143.019.09.19 1.094.208 1.172.018.08.072.129.188.107l2.924-.504.035 2.018c-1.077.281-1.801.824-2.256 1.303-.768.807-1.207 1.887-1.207 2.963 0 1.586.971 2.529 2.328 2.695 3.162.387 5.119-3.06 5.769-4.715 1.097 1.506.256 4.354-2.094 5.98-.043.029-.098.129-.033.207l.619.756c.08.096.206.059.256.023 2.51-1.73 3.661-4.515 2.869-6.683zm-7.386 3.188c-.966-.121-.944-.914-.944-1.453 0-.773.327-1.58.876-2.156a3.21 3.21 0 0 1 1.229-.799l.082 4.277a2.773 2.773 0 0 1-1.243.131zm2.427-.553l.046-4.109c.084-.004.166-.01.252-.01.773 0 1.494.145 1.885.361.391.217-1.023 2.713-2.183 3.758zm-8.95-7.668a.196.196 0 0 0-.196-.145h-1.95a.194.194 0 0 0-.194.144L.008 16.916c-.017.051-.011.076.062.076h1.733c.075 0 .099-.023.114-.072l1.008-3.318h3.496l1.008 3.318c.016.049.039.072.113.072h1.734c.072 0 .078-.025.062-.076-.014-.05-3.083-9.741-3.494-11.04zm-2.618 6.318l1.447-5.25 1.447 5.25H3.226z"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.3 KiB |
11
img/versioning.svg
Normal file
11
img/versioning.svg
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE svg PUBLIC '-//W3C//DTD SVG 1.1//EN' 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd'>
|
||||||
|
<svg enable-background="new 0 0 1190.6 841.9" version="1.1" viewBox="0 0 1190.6 841.9" xml:space="preserve" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||||
|
<defs>
|
||||||
|
<rect id="c" transform="matrix(.209 -.9779 .9779 .209 47.703 952.73)" x="287.4" y="88.5" width="650.7" height="716.8"/>
|
||||||
|
</defs>
|
||||||
|
<clipPath id="d">
|
||||||
|
<use overflow="visible" xlink:href="#c"/>
|
||||||
|
</clipPath>
|
||||||
|
<path d="m275.3 368.5c36.8-172.1 207-282.2 379.1-245.4 172.2 36.8 282.4 206.7 245.6 378.9-2.5 11.6-5.7 22.9-9.4 34.1l50.5 10.8c6.6 1.4 11.5 6.7 12.8 13.1 1.1 6.7-1.7 13.2-7.4 16.8l-134.5 86.9c-7.7 5-17.8 2.8-22.7-4.9l-87.5-134.2c-3.6-5.7-3.6-12.8 0.2-18.5 3.9-5.3 10.6-8.1 17-6.7l56 12c4.6-11 8-22.3 10.5-33.9 23.3-109-46.4-216.7-155.5-240-109-23.3-216.8 46.5-240.1 155.5s46.5 216.8 155.6 240.1c8.8 1.9 14.6 10.6 12.7 19.5l-17.6 82.1c-1.9 8.9-10.7 14.6-19.6 12.7-172.1-36.7-282.5-206.8-245.7-378.9z" clip-path="url(#d)"/>
|
||||||
|
</svg>
|
||||||
|
After Width: | Height: | Size: 1.1 KiB |
4
index.html
Normal file
4
index.html
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div><div class="homeContainer"><div class="homeSplashFade"><div class="wrapper homeWrapper"><div class="projectLogo"><img src="/img/docusaurus_keytar.svg"/></div><div class="inner"><h2 class="projectTitle">Docusaurus<small>Open Source Documentation Websites</small></h2><div class="section promoSection"><div class="promoRow"><div class="pluginRowBlock"><div class="pluginWrapper buttonWrapper"><a class="button" href="
|
||||||
|
/docs/installation.html
|
||||||
|
" target="_self">Get Started</a></div></div></div></div></div></div></div></div><div class="mainContainer"><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/markdown.png"/></div><div class="blockContent"><h2><div><p>Powered by Markdown</p></div></h2><div><p>Save time and focus on your project's documentation. Simply write docs and blog posts with Markdown and Docusaurus will publish a set of static html files ready to serve.</p></div></div></div><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/react.svg"/></div><div class="blockContent"><h2><div><p>Built Using React</p></div></h2><div><p>Extend or customize your project's layout by reusing React. Docusaurus can be extended while reusing the same header and footer.</p></div></div></div><div class="blockElement alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/translation.svg"/></div><div class="blockContent"><h2><div><p>Ready for Translations</p></div></h2><div><p>Localization comes pre-configured. Use Crowdin to translate your docs into over 70 languages.</p></div></div></div></div><br/><br/><div class="gridBlock"><div class="blockElement alignCenter imageAlignTop twoByGridBlock"><div class="blockImage"><img src="/img/versioning.svg"/></div><div class="blockContent"><h2><div><p>Document Versioning</p></div></h2><div><p>Support users on all versions of your project. Document Versioning helps you keep documentation in sync with project releases.</p></div></div></div><div class="blockElement alignCenter imageAlignTop twoByGridBlock"><div class="blockImage"><img src="/img/search.svg"/></div><div class="blockContent"><h2><div><p>Document Search</p></div></h2><div><p>Make it easy for your community to find what they need in your documentation. Currently supports Algolia DocSearch.</p></div></div></div></div></div></div><div class="container lightBackground paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockContent"><h2><div><p>Quick Setup</p></div></h2><div><p>Get up and running quickly without having having to worry about site design.</p></div></div><div class="blockImage"><img src="/img/docusaurus_speed.svg"/></div></div></div></div></div><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockImage"><img src="/img/docusaurus_live.gif"/></div><div class="blockContent"><h2><div><p>Develop and Deploy</p></div></h2><div><p>Make design and documentation changes by using the included live server. Publish your site to GitHub pages or other static file hosts manually, using a script, or with continuous integration like CircleCI.</p></div></div></div></div></div></div><div class="container lightBackground paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide twoByGridBlock"><div class="blockContent"><h2><div><p>Website Features</p></div></h2><div><p>Docusaurus currently provides support to help your website use <a href="/docs/translation.html" target="">translations</a>, <a href="/docs/search.html" target="">search</a>, and <a href="/docs/versioning.html" target="">versioning</a>, along with some other special <a href="/docs/doc-markdown.html" target="">documentation markdown features</a>. If you have ideas for useful features, feel free to contribute on <a href="https://github.com/facebookexperimental/docusaurus" target="_blank">GitHub</a>!</p></div></div><div class="blockImage"><img src="/img/docusaurus_monochrome.svg"/></div></div></div></div></div><div class="productShowcaseSection paddingBottom"><h2>Who's Using This?</h2><p>Docusaurus is building websites for these projects</p><div class="logos"><a href="https://www.prettier.io"><img src="/img/prettier.png" title="Prettier"/></a><a href="https://fasttext.cc"><img src="/img/fasttext.png" title="FastText"/></a><a href="https://www.docusaurus.io"><img src="/img/docusaurus.svg" title="Docusaurus"/></a></div><div class="more-users"><a class="button" href="/en/users.html">All Docusaurus Users</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></body></html>
|
||||||
2
users.html
Normal file
2
users.html
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Docusaurus · Open Source Documentation Websites</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Docusaurus · Open Source Documentation Websites"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Open Source Documentation Websites"/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="/css/main.css"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img src="/img/docusaurus.svg"/><h2>Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="mainContainer"><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="showcaseSection"><div class="prose"><h1>Who's Using This?</h1><p>This project is used by many folks</p></div><div class="logos"><a href="https://www.prettier.io"><img src="/img/prettier.png" title="Prettier"/></a><a href="https://fasttext.cc"><img src="/img/fasttext.png" title="FastText"/></a><a href="https://www.docusaurus.io"><img src="/img/docusaurus.svg" title="Docusaurus"/></a></div><p>Are you using this project?</p><a href="https://github.com/facebookexperimental/docusaurus/edit/master/website/siteConfig.js" class="button">Add your project</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></body></html>
|
||||||
Loading…
Add table
Add a link
Reference in a new issue