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

Deploy website

Browse source 
Deploy website version based on 3038887df4
This commit is contained in:
Website Deployment Script 2018-04-23 07:17:46 +00:00
parent 3038887df4
commit 6dc673e87e
1 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/en/next/installation.html
View file

@ -11,12 +11,15 @@
<p>While we recommend Node 8.x or greater, your Node version must at least 6.x.</p>
</blockquote></li>
<li><p>Go into the root of your GitHub repo directory where you will be creating the docs.</p></li>
<li><p><code>yarn global add docusaurus-init</code> or <code>npm install --global docusaurus-init</code></p></li>
<li><p><code>docusaurus-init</code></p></li>
<li><p><code>npx docusaurus-init</code></p>
<blockquote>
<p>If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run <code>yarn global add docusaurus-init</code> or <code>npm install --global docusaurus-init</code>. After that, run <code>docusaurus-init</code>.</p>
</blockquote></li>
</ol>
<blockquote>
<p>After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the <code>website</code> directory and typing <code>npm list docusaurus</code>. You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by typing <code>npm update</code>.</p>
<p>After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the <code>website</code> directory and typing <code>yarn outdated docusaurus</code> or <code>npm outdated docusaurus</code>. You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by typing <code>yarn upgrade docusaurus --latest</code> or <code>npm update docusaurus</code>.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="verifying-installation"></a><a href="#verifying-installation" aria-hidden="true" class="hash-link" ><svg 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>Verifying Installation</h2>
<p>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<pre><code class="hljs css bash">root-of-repo
├── docs-examples-from-docusaurus
@ -38,10 +41,6 @@
│ └── siteConfig.js
│ └── static
</code></pre>
<blockquote>
<p>If you do not want to install the init script globally, you can install it locally and then run it via <code>npx docusaurus-init</code> or from the <code>node_modules</code> directory that is created via <code>./node_modules/.bin/docusaurus-init</code>. You may want to remove the created <code>package.json</code> file and <code>node_modules</code> directory after you run the script.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="verifying-installation"></a><a href="#verifying-installation" aria-hidden="true" class="hash-link" ><svg 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>Verifying Installation</h2>
<p>Running the Docusaurus initialization script, <code>docusaurus-init</code>, produces a runnable, example website to base your site upon.</p>
<ol>
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>