mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
parent
46e7d444e4
commit
bdabf15f58
756 changed files with 3330 additions and 2962 deletions
|
@ -89,9 +89,7 @@
|
|||
<p>You have to be on Node >= 8.x and Yarn >= 1.5.</p>
|
||||
</blockquote></li>
|
||||
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
|
||||
<p>You will be creating the docs in this directory. The root directory may
|
||||
contain other files. The Docusaurus installation script will create two new
|
||||
directories: <code>docs</code> and <code>website</code>.</p>
|
||||
<p>You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: <code>docs</code> and <code>website</code>.</p>
|
||||
<blockquote>
|
||||
<p>Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.</p>
|
||||
</blockquote></li>
|
||||
|
@ -128,15 +126,11 @@ directories: <code>docs</code> and <code>website</code>.</p>
|
|||
└── static
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="running-the-example-website"></a><a href="#running-the-example-website" 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>Running the example website</h2>
|
||||
<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>
|
||||
<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>cd website</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>
|
||||
<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>
|
||||
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
|
||||
|
@ -173,7 +167,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-10-12 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.10.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-12-8 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/en/1.10.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="
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue