mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-12 08:37:25 +02:00
Website Deployment Script
parent
a8557f46ca
commit
8f1a6fbd6c
212 changed files with 552 additions and 502 deletions
|
|
@ -116,11 +116,11 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-4-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.0.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.0.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</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="
|
||||
|
|
|
|||
|
|
@ -116,11 +116,11 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-4-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.0.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.0.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</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="
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
@ -127,7 +127,7 @@
|
|||
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
|
||||
yarn start (or npm run start)
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-5-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.1.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.1.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></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="
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
@ -127,7 +127,7 @@
|
|||
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
|
||||
yarn start (or npm run start)
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-5-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.1.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.1.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></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="
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
@ -154,7 +154,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-6-15 by Andrey Rublev</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.2.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.2.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>cd website</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
@ -154,7 +154,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-6-15 by Andrey Rublev</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.2.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.2.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-8-13 by Apurav Chauhan</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.3.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.3.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-8-13 by Apurav Chauhan</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.3.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.3.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-8-13 by Apurav Chauhan</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.4.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.4.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-8-13 by Apurav Chauhan</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.4.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.4.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.5.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.5.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.5.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.5.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.6.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.6.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.6.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.6.x/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.7.3/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.7.3/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-2 by Amy Lam</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.7.3/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.7.3/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-2-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.0/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.0/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-2-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.0/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.0/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-2-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.1/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.1/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ runnable, example website to use as your site's base. To run:</p>
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically.</p>
|
||||
|
|
@ -168,7 +168,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-2-24 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.1/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.8.1/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ described in the <a href="#installing-docusaurus">Installation</a> section, you
|
|||
runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
|
|
@ -169,7 +169,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Wilson Mar</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ described in the <a href="#installing-docusaurus">Installation</a> section, you
|
|||
runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
|
|
@ -169,7 +169,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Wilson Mar</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</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/getting-started-docker.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -121,9 +121,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-9-6 by Eric Nakagawa</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/en/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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="
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ described in the <a href="#installing-docusaurus">Installation</a> section, you
|
|||
runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
|
|
@ -169,7 +169,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Wilson Mar</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ described in the <a href="#installing-docusaurus">Installation</a> section, you
|
|||
runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>cd website</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using
|
||||
<code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open
|
||||
automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
|
|
@ -169,7 +169,7 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
|
|||
<blockquote>
|
||||
<p>If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a> or run the Docusaurus server (e.g., <code>yarn start</code>) with the <code>BABEL_DISABLE_CACHE=1</code> environment configuration.</p>
|
||||
</blockquote>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Wilson Mar</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/site-preparation"><span>Site Preparation</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#installing-docusaurus">Installing Docusaurus</a></li><li><a href="#verifying-installation">Verifying Installation</a></li><li><a href="#running-the-example-website">Running the example website</a><ul class="toc-headings"><li><a href="#launching-the-server-behind-a-proxy">Launching the server behind a proxy</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</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="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
@ -129,7 +132,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-29 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-5-17 by TurekBot</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="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
@ -129,7 +132,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-29 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-5-17 by TurekBot</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="
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
<span class="hljs-bullet">* </span>Let's Go
|
||||
</code></pre>
|
||||
<ol start="3">
|
||||
<li>Go to <code>sidebars.json</code> and add <code>"doc4"</code> after <code>"doc1"</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>"doc4"</code> after <code>"doc1"</code>. This ID should be the same one as in the Markdown file above.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff">{
|
||||
"docs": {
|
||||
|
|
@ -152,12 +152,12 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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/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>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-16 by TurekBot</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-5-17 by TurekBot</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="
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
<span class="hljs-bullet">* </span>Let's Go
|
||||
</code></pre>
|
||||
<ol start="3">
|
||||
<li>Go to <code>sidebars.json</code> and add <code>"doc4"</code> after <code>"doc1"</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>"doc4"</code> after <code>"doc1"</code>. This ID should be the same one as in the Markdown file above.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff">{
|
||||
"docs": {
|
||||
|
|
@ -152,12 +152,12 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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/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>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-16 by TurekBot</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-5-17 by TurekBot</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="
|
||||
|
|
|
|||
|
|
@ -79,7 +79,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-publish-site.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Publish the Site</h1></header><article><div><span><p><img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage"/></p>
|
||||
<p>Next we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="put-the-site-online"></a><a href="#put-the-site-online" 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>Put the Site Online</h2>
|
||||
<p>Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>In <code>website/siteConfig.js</code>, fill in the following fields:</p>
|
||||
<pre><code class="hljs">const siteConfig = {
|
||||
<span class="hljs-params">...</span>
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
<blockquote>
|
||||
<p>Note that when you run <code>npm run start</code> again, the <code>baseUrl</code> will now be part of the path.</p>
|
||||
</blockquote>
|
||||
</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-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/next/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/next/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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="
|
||||
|
|
|
|||
|
|
@ -79,7 +79,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-publish-site.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Publish the Site</h1></header><article><div><span><p><img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage"/></p>
|
||||
<p>Next we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="put-the-site-online"></a><a href="#put-the-site-online" 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>Put the Site Online</h2>
|
||||
<p>Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>In <code>website/siteConfig.js</code>, fill in the following fields:</p>
|
||||
<pre><code class="hljs">const siteConfig = {
|
||||
<span class="hljs-params">...</span>
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
<blockquote>
|
||||
<p>Note that when you run <code>npm run start</code> again, the <code>baseUrl</code> will now be part of the path.</p>
|
||||
</blockquote>
|
||||
</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-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/next/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/next/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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="
|
||||
|
|
|
|||
|
|
@ -114,7 +114,9 @@ v8.15.1
|
|||
<ol start="5">
|
||||
<li>Clone your repository to your local machine:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># SSH</span>
|
||||
<span class="hljs-comment"># or</span>
|
||||
git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># HTTPS</span>
|
||||
</code></pre>
|
||||
<ol start="6">
|
||||
<li><code>cd</code> into the repository which you just created.</li>
|
||||
|
|
@ -129,7 +131,7 @@ v8.15.1
|
|||
<p>or if you have Yarn:</p>
|
||||
<pre><code class="hljs css language-sh">yarn global add docusaurus-init
|
||||
</code></pre>
|
||||
</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-next button" href="/docs/en/next/tutorial-create-new-site"><span>Create a New Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-nodejs">Install Node.js</a></li><li><a href="#check-your-nodejs-installation">Check your Node.js installation</a></li><li><a href="#install-yarn-optional">Install Yarn (Optional)</a></li><li><a href="#create-a-github-repository">Create a GitHub Repository</a></li><li><a href="#install-the-docusaurus-init-command">Install the Docusaurus init command</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-5-17 by TurekBot</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/tutorial-create-new-site"><span>Create a New Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-nodejs">Install Node.js</a></li><li><a href="#check-your-nodejs-installation">Check your Node.js installation</a></li><li><a href="#install-yarn-optional">Install Yarn (Optional)</a></li><li><a href="#create-a-github-repository">Create a GitHub Repository</a></li><li><a href="#install-the-docusaurus-init-command">Install the Docusaurus init command</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="
|
||||
|
|
|
|||
|
|
@ -114,7 +114,9 @@ v8.15.1
|
|||
<ol start="5">
|
||||
<li>Clone your repository to your local machine:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># SSH</span>
|
||||
<span class="hljs-comment"># or</span>
|
||||
git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># HTTPS</span>
|
||||
</code></pre>
|
||||
<ol start="6">
|
||||
<li><code>cd</code> into the repository which you just created.</li>
|
||||
|
|
@ -129,7 +131,7 @@ v8.15.1
|
|||
<p>or if you have Yarn:</p>
|
||||
<pre><code class="hljs css language-sh">yarn global add docusaurus-init
|
||||
</code></pre>
|
||||
</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-next button" href="/docs/en/next/tutorial-create-new-site"><span>Create a New Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-nodejs">Install Node.js</a></li><li><a href="#check-your-nodejs-installation">Check your Node.js installation</a></li><li><a href="#install-yarn-optional">Install Yarn (Optional)</a></li><li><a href="#create-a-github-repository">Create a GitHub Repository</a></li><li><a href="#install-the-docusaurus-init-command">Install the Docusaurus init command</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-5-17 by TurekBot</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/next/tutorial-create-new-site"><span>Create a New Site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-nodejs">Install Node.js</a></li><li><a href="#check-your-nodejs-installation">Check your Node.js installation</a></li><li><a href="#install-yarn-optional">Install Yarn (Optional)</a></li><li><a href="#create-a-github-repository">Create a GitHub Repository</a></li><li><a href="#install-the-docusaurus-init-command">Install the Docusaurus init command</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="
|
||||
|
|
|
|||
|
|
@ -145,12 +145,12 @@
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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>
|
||||
</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-29 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/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="
|
||||
|
|
|
|||
|
|
@ -145,12 +145,12 @@
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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>
|
||||
</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-29 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/en/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="
|
||||
|
|
|
|||
|
|
@ -79,7 +79,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-publish-site.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Publish the Site</h1></header><article><div><span><p><img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage"/></p>
|
||||
<p>Next we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="put-the-site-online"></a><a href="#put-the-site-online" 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>Put the Site Online</h2>
|
||||
<p>Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>In <code>website/siteConfig.js</code>, fill in the following fields:</p>
|
||||
<pre><code class="hljs">const siteConfig = {
|
||||
<span class="hljs-params">...</span>
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
<blockquote>
|
||||
<p>Note that when you run <code>npm run start</code> again, the <code>baseUrl</code> will now be part of the path.</p>
|
||||
</blockquote>
|
||||
</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/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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="
|
||||
|
|
|
|||
|
|
@ -79,7 +79,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-publish-site.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Publish the Site</h1></header><article><div><span><p><img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage"/></p>
|
||||
<p>Next we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="put-the-site-online"></a><a href="#put-the-site-online" 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>Put the Site Online</h2>
|
||||
<p>Kill the webserver first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>In <code>website/siteConfig.js</code>, fill in the following fields:</p>
|
||||
<pre><code class="hljs">const siteConfig = {
|
||||
<span class="hljs-params">...</span>
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
<blockquote>
|
||||
<p>Note that when you run <code>npm run start</code> again, the <code>baseUrl</code> will now be part of the path.</p>
|
||||
</blockquote>
|
||||
</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/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/tutorial-create-pages"><span class="arrow-prev">← </span><span>Create Pages</span></a><a class="docs-next button" href="/docs/en/tutorial-version"><span>Add Versions</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#put-the-site-online">Put the Site Online</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="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
|
|||
|
|
@ -114,7 +114,9 @@ v8.15.1
|
|||
<ol start="5">
|
||||
<li>Clone your repository to your local machine:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># SSH</span>
|
||||
<span class="hljs-comment"># or</span>
|
||||
git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># HTTPS</span>
|
||||
</code></pre>
|
||||
<ol start="6">
|
||||
<li><code>cd</code> into the repository which you just created.</li>
|
||||
|
|
|
|||
|
|
@ -114,7 +114,9 @@ v8.15.1
|
|||
<ol start="5">
|
||||
<li>Clone your repository to your local machine:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git
|
||||
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># SSH</span>
|
||||
<span class="hljs-comment"># or</span>
|
||||
git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># HTTPS</span>
|
||||
</code></pre>
|
||||
<ol start="6">
|
||||
<li><code>cd</code> into the repository which you just created.</li>
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -118,7 +118,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@
|
|||
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
|
||||
<li><code>siteweb cd</code></li>
|
||||
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
|
||||
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>Run the local web server via <code>yarn start</code> or <code>npm start</code>.</li>
|
||||
<li>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. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</li>
|
||||
</ol>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.4.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.4.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.5.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.5.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.6.x/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.6.x/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.7.3/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.7.3/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.0/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.0/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/1.8.1/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/1.8.1/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
<li><p>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</p></li>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@
|
|||
<p>After running the Docusaurus initialization script, <code>docusaurus-init</code> as described in the <a href="#installing-docusaurus">Installation</a> section, you will have a runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@
|
|||
<p>After running the Docusaurus initialization script, <code>docusaurus-init</code> as described in the <a href="#installing-docusaurus">Installation</a> section, you will have a runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -77,9 +77,9 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ro" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Docker</h1></header><article><div><span><p><a href="https://www.docker.com/">Docker</a> is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-webserver-in-docker"></a><a href="#run-the-local-webserver-in-docker" 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>Run the local webserver in docker</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="run-the-local-web-server-in-docker"></a><a href="#run-the-local-web-server-in-docker" 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>Run the local web server in docker</h2>
|
||||
<p>Ensure you have previously installed <a href="https://www.docker.com/get-started">docker</a>.</p>
|
||||
<p>To run the local webserver:</p>
|
||||
<p>To run the local web server:</p>
|
||||
<ol>
|
||||
<li><p><strong>Build the docker image</strong> -- Enter the folder where you have Docusaurus installed. Run <code>docker build -t docusaurus-doc .</code></p>
|
||||
<p>Once the build phase finishes, you can verify the image exists by running <code>docker images</code>.</p>
|
||||
|
|
@ -90,7 +90,7 @@
|
|||
<p>This will start a docker container with the image <code>docusaurus-doc</code>. To see more detailed container info run <code>docker ps</code> .</p></li>
|
||||
</ol>
|
||||
<h2><a class="anchor" aria-hidden="true" id="use-docker-compose"></a><a href="#use-docker-compose" 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>Use docker-compose</h2>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.</p>
|
||||
<p>We can also use <code>docker-compose</code> to configure our application. This feature of docker allows you to run the web server and any additional services with a single command.</p>
|
||||
<blockquote>
|
||||
<p>Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.</p>
|
||||
</blockquote>
|
||||
|
|
@ -122,9 +122,9 @@
|
|||
<span class="hljs-attr"> working_dir:</span> <span class="hljs-string">/app/website</span>
|
||||
|
||||
</code></pre>
|
||||
<p>To run a local webserver with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To run a local web server with <code>docker-compose</code> run <code>docker-compose up</code>.</p>
|
||||
<p>To build static HTML pages for publishing run <code>docker-compose run docusaurus bash -c 'yarn publish-gh-pages'</code></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-webserver-in-docker">Run the local webserver in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ro/next/publishing"><span class="arrow-prev">← </span><span>Publishing your site</span></a><a class="docs-next button" href="/docs/ro/next/adding-blog"><span>Adding a Blog</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#run-the-local-web-server-in-docker">Run the local web server in docker</a></li><li><a href="#use-docker-compose">Use docker-compose</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/ro/installation">Getting Started</a><a href="
|
||||
/docs/ro/versioning">Versioning</a><a href="
|
||||
/docs/ro/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@
|
|||
<p>After running the Docusaurus initialization script, <code>docusaurus-init</code> as described in the <a href="#installing-docusaurus">Installation</a> section, you will have a runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@
|
|||
<p>After running the Docusaurus initialization script, <code>docusaurus-init</code> as described in the <a href="#installing-docusaurus">Installation</a> section, you will have a runnable, example website to use as your site's base. To run:</p>
|
||||
<ol>
|
||||
<li><p><code>siteweb cd</code></p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local webserver using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>From within the <code>website</code> directory, run the local web server using <code>yarn start</code> or <code>npm start</code>.</p></li>
|
||||
<li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a> if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.</p>
|
||||
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you.</p></li>
|
||||
</ol>
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
|
|||
|
|
@ -84,6 +84,9 @@
|
|||
</ol>
|
||||
<pre><code class="hljs css language-sh">docusaurus-init
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The <code>Linking dependencies...</code> step might take a while, but it will finish eventually.</p>
|
||||
</blockquote>
|
||||
<p>The following contents will be created for you in the directory you are in.</p>
|
||||
<pre><code class="hljs css language-sh">├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ul></li>
|
||||
</ol>
|
||||
<ol start="3">
|
||||
<li>Go to <code>sidebars.json</code> and add <code>"doc4"</code> after <code>"doc1"</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>"doc4"</code> after <code>"doc1"</code>. This ID should be the same one as in the Markdown file above.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff">{
|
||||
"docs": {
|
||||
|
|
@ -145,7 +145,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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/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>
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ul></li>
|
||||
</ol>
|
||||
<ol start="3">
|
||||
<li>Go to <code>sidebars.json</code> and add <code>"doc4"</code> after <code>"doc1"</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>"doc4"</code> after <code>"doc1"</code>. This ID should be the same one as in the Markdown file above.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff">{
|
||||
"docs": {
|
||||
|
|
@ -145,7 +145,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
}
|
||||
</code></pre>
|
||||
<ol start="4">
|
||||
<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>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/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>
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue