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

Deploy website

Browse source 
Deploy website version based on ecf1f9a2c4
This commit is contained in:
Website Deployment Script 2019-04-28 05:53:18 +00:00
parent 3ec53a2478
commit bb22621415
20 changed files with 64 additions and 94 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/en/next/site-preparation.html
View file

@ -80,14 +80,14 @@
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" 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>Directory Structure</h2>
<p>As shown after you <a href="/docs/en/next/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
<pre><code class="hljs css language-bash">root-directory
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
└── website
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
@ -101,14 +101,11 @@
├── siteConfig.js
└── static
</code></pre>
<blockquote>
<p>You may have already renamed the example blog (<code>website/blog-examples-from-docusaurus</code> to <code>website/blog</code>) and document (<code>docs-examples-from-docusaurus</code> to <code>docs</code>) directories when you <a href="/docs/en/next/installation##verifying-installation">verified the installation</a>.</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" 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>Directory Descriptions</h3>
<ul>
<li><strong>Documentation Source Files</strong>: The <code>docs-examples-from-docusaurus</code> directory
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
contains example documentation files written in Markdown.</li>
<li><strong>Blog</strong>: The <code>website/blog-examples-from-docusaurus</code> directory contains examples of blog posts written in markdown.</li>
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
</ul>
@ -124,7 +121,7 @@ of the documentation files.</li>
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" 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>Preparation Notes</h2>
<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. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You 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>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-11-11 by Alexandre ZANNI</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</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-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</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="

13
docs/en/next/site-preparation/index.html
View file

@ -80,14 +80,14 @@
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" 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>Directory Structure</h2>
<p>As shown after you <a href="/docs/en/next/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
<pre><code class="hljs css language-bash">root-directory
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
└── website
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
@ -101,14 +101,11 @@
├── siteConfig.js
└── static
</code></pre>
<blockquote>
<p>You may have already renamed the example blog (<code>website/blog-examples-from-docusaurus</code> to <code>website/blog</code>) and document (<code>docs-examples-from-docusaurus</code> to <code>docs</code>) directories when you <a href="/docs/en/next/installation##verifying-installation">verified the installation</a>.</p>
</blockquote>
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" 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>Directory Descriptions</h3>
<ul>
<li><strong>Documentation Source Files</strong>: The <code>docs-examples-from-docusaurus</code> directory
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
contains example documentation files written in Markdown.</li>
<li><strong>Blog</strong>: The <code>website/blog-examples-from-docusaurus</code> directory contains examples of blog posts written in markdown.</li>
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
</ul>
@ -124,7 +121,7 @@ of the documentation files.</li>
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" 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>Preparation Notes</h2>
<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. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You 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>
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-11-11 by Alexandre ZANNI</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</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-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</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="

6
docs/en/next/tutorial-create-new-site.html
View file

@ -85,7 +85,7 @@
<p>The following contents will be created for you in the directory you are in (TODO).</p>
<pre><code class="hljs css language-sh">├── Dockerfile
├── docker-compose.yml
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
@ -93,7 +93,7 @@
│ └── exampledoc5.md
└── website
├── README.md
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
@ -127,7 +127,7 @@
</ol>
<p>A browser window will open up at <a href="http://localhost:3000">http://localhost:3000</a>.</p>
<p>Congratulations, you have just made your first Docusaurus site! Click around the pages generated for you to see what's available.</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-setup"><span class="arrow-prev">← </span><span>Setting Up</span></a><a class="docs-next button" href="/docs/en/next/tutorial-create-pages"><span>Create Pages</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#scaffold-the-site">Scaffold the Site</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-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-setup"><span class="arrow-prev">← </span><span>Setting Up</span></a><a class="docs-next button" href="/docs/en/next/tutorial-create-pages"><span>Create Pages</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#scaffold-the-site">Scaffold the Site</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="

6
docs/en/next/tutorial-create-new-site/index.html
View file

@ -85,7 +85,7 @@
<p>The following contents will be created for you in the directory you are in (TODO).</p>
<pre><code class="hljs css language-sh">├── Dockerfile
├── docker-compose.yml
├── docs-examples-from-docusaurus
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
@ -93,7 +93,7 @@
│ └── exampledoc5.md
└── website
├── README.md
├── blog-examples-from-docusaurus
├── blog
│ ├── 2016-03-11-blog-post.md
│ ├── 2017-04-10-blog-post-two.md
│ ├── 2017-09-25-testing-rss.md
@ -127,7 +127,7 @@
</ol>
<p>A browser window will open up at <a href="http://localhost:3000">http://localhost:3000</a>.</p>
<p>Congratulations, you have just made your first Docusaurus site! Click around the pages generated for you to see what's available.</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-setup"><span class="arrow-prev">← </span><span>Setting Up</span></a><a class="docs-next button" href="/docs/en/next/tutorial-create-pages"><span>Create Pages</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#scaffold-the-site">Scaffold the Site</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-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-setup"><span class="arrow-prev">← </span><span>Setting Up</span></a><a class="docs-next button" href="/docs/en/next/tutorial-create-pages"><span>Create Pages</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#scaffold-the-site">Scaffold the Site</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="