mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-23 14:06:59 +02:00
parent
1bb933dd9b
commit
58243eb531
2 changed files with 20 additions and 16 deletions
|
@ -27,7 +27,7 @@
|
||||||
<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>
|
<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>
|
||||||
<h2><a class="anchor" aria-hidden="true" id="verifying-installation"></a><a href="#verifying-installation" 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>Verifying Installation</h2>
|
<h2><a class="anchor" aria-hidden="true" id="verifying-installation"></a><a href="#verifying-installation" 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>Verifying Installation</h2>
|
||||||
<p>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
|
<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
|
<pre><code class="hljs css bash">root-directory
|
||||||
├── docs-examples-from-docusaurus
|
├── docs-examples-from-docusaurus
|
||||||
│ ├── doc1.md
|
│ ├── doc1.md
|
||||||
│ ├── doc2.md
|
│ ├── doc2.md
|
||||||
|
@ -37,10 +37,12 @@
|
||||||
└── website
|
└── website
|
||||||
├── blog-examples-from-docusaurus
|
├── blog-examples-from-docusaurus
|
||||||
│ ├── 2016-03-11-blog-post.md
|
│ ├── 2016-03-11-blog-post.md
|
||||||
│ └── 2017-04-10-blog-post-two.md
|
│ ├── 2017-04-10-blog-post-two.md
|
||||||
|
│ ├── 2017-09-25-testing-rss.md
|
||||||
|
│ ├── 2017-09-26-adding-rss.md
|
||||||
|
│ └── 2017-10-24-new-version-1.0.0.md
|
||||||
├── core
|
├── core
|
||||||
│ └── Footer.js
|
│ └── Footer.js
|
||||||
├── node_modules
|
|
||||||
├── package.json
|
├── package.json
|
||||||
├── pages
|
├── pages
|
||||||
├── sidebars.json
|
├── sidebars.json
|
||||||
|
|
|
@ -15,25 +15,27 @@
|
||||||
</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-preparation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1>Site Preparation</h1></header><article><div><span><p>After <a href="/docs/en/next/installation.html">installing Docusaurus</a>, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.</p>
|
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebook/docusaurus/edit/master/docs/getting-started-preparation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1>Site Preparation</h1></header><article><div><span><p>After <a href="/docs/en/next/installation.html">installing Docusaurus</a>, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.</p>
|
||||||
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Structure</h2>
|
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Structure</h2>
|
||||||
<p>As shown after you <a href="/docs/en/next/installation.html">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
<p>As shown after you <a href="/docs/en/next/installation.html">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||||
<pre><code class="hljs css bash">root-of-repo
|
<pre><code class="hljs css bash">root-directory
|
||||||
├── docs-examples-from-docusaurus
|
├── docs-examples-from-docusaurus
|
||||||
│ ├── doc1.md
|
│ ├── doc1.md
|
||||||
│ ├── doc2.md
|
│ ├── doc2.md
|
||||||
│ ├── doc3.md
|
│ ├── doc3.md
|
||||||
│ ├── exampledoc4.md
|
│ ├── exampledoc4.md
|
||||||
│ └── exampledoc5.md
|
│ └── exampledoc5.md
|
||||||
├── website
|
└── website
|
||||||
│ ├── blog-examples-from-docusaurus
|
├── blog-examples-from-docusaurus
|
||||||
│ │ ├── 2016-03-11-blog-post.md
|
│ ├── 2016-03-11-blog-post.md
|
||||||
│ │ └── 2017-04-10-blog-post-two.md
|
│ ├── 2017-04-10-blog-post-two.md
|
||||||
│ ├── core
|
│ ├── 2017-09-25-testing-rss.md
|
||||||
│ │ └── Footer.js
|
│ ├── 2017-09-26-adding-rss.md
|
||||||
│ ├── node_modules
|
│ └── 2017-10-24-new-version-1.0.0.md
|
||||||
│ ├── package.json
|
├── core
|
||||||
│ ├── pages
|
│ └── Footer.js
|
||||||
│ ├── sidebars.json
|
├── package.json
|
||||||
│ ├── siteConfig.js
|
├── pages
|
||||||
│ └── static
|
├── sidebars.json
|
||||||
|
├── siteConfig.js
|
||||||
|
└── static
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>You may have already renamed the example blog (<code>website/blog-examples-from-docusaurus</code>) and document (<code>docs-examples-from-docusaurus</code>) directories when you <a href="/docs/en/next/installation.html##verifying-installation">verified the installation</a>.</p>
|
<p>You may have already renamed the example blog (<code>website/blog-examples-from-docusaurus</code>) and document (<code>docs-examples-from-docusaurus</code>) directories when you <a href="/docs/en/next/installation.html##verifying-installation">verified the installation</a>.</p>
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue