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

Deploy website

Browse source 
Deploy website version based on 7e1e3e9a4c
This commit is contained in:
Website Deployment Script 2019-05-21 11:10:46 +00:00
parent 199e116e3c
commit 5064176782
560 changed files with 48747 additions and 1902 deletions
Download patch file Download diff file Expand all files Collapse all files

45
docs/en/tutorial-create-pages.html
View file

@ -1,5 +1,5 @@
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Create Pages · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="&lt;p&gt;In this section we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.&lt;/p&gt;
"/><meta name="docsearch:version" content="1.9.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Create Pages · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="&lt;p&gt;In this section we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.&lt;/p&gt;
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Create Pages · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="&lt;p&gt;In this section, we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.&lt;/p&gt;
"/><meta name="docsearch:version" content="1.10.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Create Pages · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="&lt;p&gt;In this section, we will learn about creating two new types of pages in Docusaurus, a regular page and a documentation page.&lt;/p&gt;
"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
@ -14,7 +14,7 @@
{"zIndex":100}
)
});
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/en/versions"><h3>1.9.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/en/installation" target="_self">Docs</a></li><li class=""><a href="/docs/en/next/tutorial-setup" target="_self">Tutorial</a></li><li class=""><a href="/en/users" target="_self">Users</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/es-ES/tutorial-create-pages">Español</a></li><li><a href="/docs/ro/tutorial-create-pages">Română</a></li><li><a href="/docs/tr/tutorial-create-pages">Türkçe</a></li><li><a href="/docs/zh-CN/tutorial-create-pages">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Us Translate</a></li></ul></div></li><script>
</script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/en/versions"><h3>1.10.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/en/installation" target="_self">Docs</a></li><li class=""><a href="/docs/en/next/tutorial-setup" target="_self">Tutorial</a></li><li class=""><a href="/en/users" target="_self">Users</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/es-ES/tutorial-create-pages">Español</a></li><li><a href="/docs/ro/tutorial-create-pages">Română</a></li><li><a href="/docs/tr/tutorial-create-pages">Türkçe</a></li><li><a href="/docs/zh-CN/tutorial-create-pages">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Us Translate</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
@ -82,7 +82,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>
</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 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>
@ -110,37 +110,44 @@
</code></pre>
<ol start="2">
<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>
<li>Change the text within the <code>&lt;p&gt;...&lt;/p&gt;</code> to &quot;I can write JSX here!&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>
<span class="hljs-addition">+ &lt;p&gt;I can write JSX here!&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>React is being used as a templating engine for rendering static markup. You can leverage on the expressibility 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>
<ol>
<li>Create a new file in the <code>docs</code> folder called <code>f8.md</code>.</li>
<li>Create a new file in the <code>docs</code> folder called <code>doc4.md</code>. The <code>docs</code> folder is in the root of your Docusaurus project, one level above <code>website</code>.</li>
<li>Paste the following contents:</li>
</ol>
<pre><code class="hljs"><span class="hljs-meta">---</span>
<span class="hljs-attr">id:</span> <span class="hljs-string">f8</span>
<span class="hljs-attr">title:</span> <span class="hljs-string">Hello</span> <span class="hljs-string">F8</span>
<span class="hljs-meta">---</span>
<pre><code class="hljs">---
id: doc4
<span class="hljs-section">title: This is Doc 4
---</span>
<span class="hljs-string">Hello</span> <span class="hljs-string">F8!</span> <span class="hljs-string">I'm</span> <span class="hljs-string">at</span> <span class="hljs-string">the</span> <span class="hljs-string">Docusaurus</span> <span class="hljs-string">classroom</span> <span class="hljs-string">session!</span>
I can write content using [<span class="hljs-string">GitHub-flavored Markdown syntax</span>](<span class="hljs-link">https://github.github.com/gfm/</span>).
<span class="hljs-comment">## Using Docusaurus to Create Open Source Websites</span>
<span class="hljs-section">## Markdown Syntax</span>
<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>
<span class="hljs-strong">**Bold**</span> <span class="hljs-emphasis">_italic_</span> <span class="hljs-code">`code`</span> [<span class="hljs-string">Links</span>](<span class="hljs-link">#url</span>)
<span class="hljs-quote">&gt; Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse</span>
<span class="hljs-quote">&gt; id sem consectetuer libero luctus adipiscing.</span>
<span class="hljs-bullet">* </span>Hey
<span class="hljs-bullet">* </span>Ho
<span class="hljs-bullet">* </span>Let's Go
</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>. This ID should be the same one as in the Markdown file above.</li>
<li>Go to <code>website/sidebars.json</code> and add <code>&quot;doc4&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": {
"Docusaurus": [
"doc1",
<span class="hljs-addition">+ "f8"</span>
<span class="hljs-addition">+ "doc4"</span>
],
"First Category": ["doc2"],
"Second Category": ["doc3"]
@ -152,7 +159,7 @@
</code></pre>
<ol start="4">
<li>Kill your web server (<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>
<li>Navigate to <a href="http://localhost:3000/docs/doc4">http://localhost:3000/docs/doc4</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>
@ -178,6 +185,6 @@
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react',
algoliaOptions: {"facetFilters":["language:en","version:1.9.0"]}
algoliaOptions: {"facetFilters":["language:en","version:1.10.0"]}
});
</script></body></html>