3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-11 08:07:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 2fe73edc22
This commit is contained in:
Website Deployment Script 2019-04-29 17:50:25 +00:00
parent da1e259324
commit 09574c073c
55 changed files with 1736 additions and 196 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/en/next/tutorial-create-pages/index.html
View file

@ -26,7 +26,7 @@
languagesDropDown.className = "hide";
}
});
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Tutorial</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Tutorial<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-setup">Setting Up</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-create-new-site">Create a New Site</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/next/tutorial-create-pages">Create Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-publish-site">Publish the Site</a></li></ul></div></div></section></div><script>
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Tutorial</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Tutorial<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-setup">Setting Up</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-create-new-site">Create a New Site</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/next/tutorial-create-pages">Create Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-publish-site">Publish the Site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tutorial-version">Add Versions</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
@ -77,7 +77,7 @@
}
});
</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/facebook/docusaurus/edit/master/docs/tutorial-create-pages.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.</p>
<p><img alt="Docusaurus process" src="/img/undraw_docusaurus_process.svg" class="docImage"/></p>
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage"/></p>
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Creating a Regular Page</h2>
<ol>
<li>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</li>
@ -103,9 +103,12 @@
<span class="hljs-built_in">module</span>.exports = HelloWorld;
</code></pre>
<ol start="2">
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> (TODO) and you should be able to see the new page.</li>
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
<li>Change the text within the <code>&lt;p&gt;...&lt;/p&gt;</code> to &quot;I'm at F8!&quot;. The browser should refresh automatically to reflect the changes.</li>
</ol>
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- &lt;p&gt;This is my first page!&lt;/p&gt;</span>
<span class="hljs-addition">+ &lt;p&gt;I'm at F8!&lt;/p&gt;</span>
</code></pre>
<p>React is being used as a templating engine for rendering static markup. You can leverage on the expressability of React to build rich web content. Learn more about creating pages <a href="custom-pages">here</a>.</p>
<p><img alt="Docusaurus React" src="/img/undraw_docusaurus_react.svg" class="docImage"/></p>
<h2><a class="anchor" aria-hidden="true" id="create-a-documentation-page"></a><a href="#create-a-documentation-page" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Create a Documentation Page</h2>
@ -125,12 +128,14 @@
<span class="hljs-string">In</span> <span class="hljs-string">this</span> <span class="hljs-string">session,</span> <span class="hljs-string">we</span> <span class="hljs-string">learned</span> <span class="hljs-string">how</span> <span class="hljs-string">Docusaurus</span> <span class="hljs-string">makes</span> <span class="hljs-string">it</span> <span class="hljs-string">really</span> <span class="hljs-string">simple</span> <span class="hljs-string">to</span> <span class="hljs-string">create</span> <span class="hljs-string">a</span> <span class="hljs-string">website</span> <span class="hljs-string">for</span> <span class="hljs-string">open</span> <span class="hljs-string">source</span> <span class="hljs-string">project</span> <span class="hljs-string">documentation</span> <span class="hljs-string">and</span> <span class="hljs-string">get</span> <span class="hljs-string">hands</span> <span class="hljs-string">on</span> <span class="hljs-string">by</span> <span class="hljs-string">creating</span> <span class="hljs-string">a</span> <span class="hljs-string">Docusaurus</span> <span class="hljs-string">website.</span>
</code></pre>
<ol start="3">
<li>Go to <code>sidebars.json</code> and add <code>&quot;f8&quot;</code> after <code>&quot;doc1&quot;</code>.</li>
<li>Go to <code>sidebars.json</code> and add <code>&quot;f8&quot;</code> after <code>&quot;doc1&quot;</code>. This ID should be the same one as in the Markdown file above.</li>
</ol>
<pre><code class="hljs css language-diff">{
"docs": {
<span class="hljs-addition">+ "Docusaurus": ["doc1", "f8"],</span>
<span class="hljs-deletion">- "Docusaurus": ["doc1"],</span>
"Docusaurus": [
"doc1",
<span class="hljs-addition">+ "f8"</span>
],
"First Category": ["doc2"],
"Second Category": ["doc3"]
},
@ -140,11 +145,12 @@
}
</code></pre>
<ol start="4">
<li>Navigate to <a href="http://localhost:3000/docs/f8">http://localhost:3000/docs/f8</a>. (TODO)</li>
<li>Kill your webserver (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with <code>npm run start</code>) because a server restart is needed for sidebar changes.</li>
<li>Navigate to <a href="http://localhost:3000/docs/f8">http://localhost:3000/docs/f8</a>.</li>
</ol>
<p>You've created your first documentation page on Docusaurus! The <code>sidebars.json</code> is where you specify the order of your documentation pages and in the front matter of the Markdown file is where you provide metadata about that page.</p>
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-23 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/next/tutorial-publish-site"><span>Publish the Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#creating-a-regular-page">Creating a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-29 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/next/tutorial-publish-site"><span>Publish the Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#creating-a-regular-page">Creating a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
/docs/en/installation">Getting Started</a><a href="
/docs/en/versioning">Versioning</a><a href="
/docs/en/translation">Localization</a><a href="