mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-14 09:37:37 +02:00
Website Deployment Script
parent
a1ef13941f
commit
6f9d2c4605
84 changed files with 504 additions and 328 deletions
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.10.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.10.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.10.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.10.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.10.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.10.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.11.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.11.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.11.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.11.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.11.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.11.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.9.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.9.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.9.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/1.9.x/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-4-28 by Yangshun Tay</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.9.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/1.9.x/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Structure</h2>
|
||||
<p>As shown after you <a href="/docs/en/next/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="directory-structure"></a><a href="#directory-structure" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Structure</h2>
|
||||
<p>As shown after you <a href="/docs/en/next/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/next/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/tutorial-create-pages.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage"/></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</li>
|
||||
<li>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs"><span class="hljs-keyword">const</span> React = <span class="hljs-built_in">require</span>(<span class="hljs-string">'react'</span>);
|
||||
|
||||
|
|
@ -106,9 +106,12 @@
|
|||
|
||||
<span class="hljs-built_in">module</span>.exports = HelloWorld;
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -161,7 +164,7 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</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-31 by orangehat</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-7-26 by Jay Martin</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="#create-a-regular-page">Create 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="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/tutorial-create-pages.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage"/></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</li>
|
||||
<li>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs"><span class="hljs-keyword">const</span> React = <span class="hljs-built_in">require</span>(<span class="hljs-string">'react'</span>);
|
||||
|
||||
|
|
@ -106,9 +106,12 @@
|
|||
|
||||
<span class="hljs-built_in">module</span>.exports = HelloWorld;
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -161,7 +164,7 @@ I can write content using [<span class="hljs-string">GitHub-flavored Markdown sy
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</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-31 by orangehat</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-7-26 by Jay Martin</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="#create-a-regular-page">Create 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="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
@ -146,7 +146,7 @@ git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusau
|
|||
<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-7-25 by Jay Martin</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-git">Install Git</a></li><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-and-local-clone">Create a GitHub repository and local clone</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-7-26 by Jay Martin</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-git">Install Git</a></li><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-and-local-clone">Create a GitHub repository and local clone</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="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
@ -146,7 +146,7 @@ git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusau
|
|||
<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-7-25 by Jay Martin</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-git">Install Git</a></li><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-and-local-clone">Create a GitHub repository and local clone</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-7-26 by Jay Martin</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-git">Install Git</a></li><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-and-local-clone">Create a GitHub repository and local clone</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="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<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/installation">installed Docusaurus</a>, the initialization script created a directory structure similar to:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,25 +108,23 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="directory-descriptions"></a><a href="#directory-descriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Directory Descriptions</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory
|
||||
contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>Blog</strong>: The <code>website/blog</code> directory contains examples of blog posts written in markdown.</li>
|
||||
<li><strong>Pages</strong>: The <code>website/pages</code> directory contains example top-level pages for the site.</li>
|
||||
<li><strong>Static files and images</strong>: The <code>website/static</code> directory contains static assets used by the example site.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="key-files"></a><a href="#key-files" 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>Key Files</h3>
|
||||
<ul>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts
|
||||
as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main
|
||||
configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order
|
||||
of the documentation files.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="preparation-notes"></a><a href="#preparation-notes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Preparation Notes</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-5-17 by Hongarc</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-7-26 by Wei Gao</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/en/site-creation"><span>Creating your site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#directory-structure">Directory Structure</a><ul class="toc-headings"><li><a href="#directory-descriptions">Directory Descriptions</a></li><li><a href="#key-files">Key Files</a></li></ul></li><li><a href="#preparation-notes">Preparation Notes</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.10.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.10.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.10.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.10.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.10.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.11.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.11.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.11.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.11.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.11.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.9.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Barre latérale</strong>: Le fichier <code>sidebars.json</code> contient la structure et l'ordre des fichiers de documentation.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.9.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/1.9.x/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Barre latérale</strong>: Le fichier <code>sidebars.json</code> contient la structure et l'ordre des fichiers de documentation.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/1.9.x/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/1.9.x/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/next/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/next/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/next/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/next/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/next/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/fr" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/fr/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><li><a href="#markdown-syntax">Markdown Syntax</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/fr/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/fr/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
/docs/fr/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/fr" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/fr/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><li><a href="#markdown-syntax">Markdown Syntax</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/fr/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/fr/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
/docs/fr/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="structure-de-fichiers"></a><a href="#structure-de-fichiers" 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>Structure de fichiers</h2>
|
||||
<p>Comme indiqué après l'<a href="/docs/fr/installation">installation de Docusaurus</a>, le script d'initialisation a crée une structure de dossier similaire à:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="fichiers-cle"></a><a href="#fichiers-cle" 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>Fichiers clé</h3>
|
||||
<ul>
|
||||
<li><strong>Pied de page</strong>: Le fichier <code>website/core/Footer.js</code> est un composant React qui sert comme pied de page pour le site généré par Docusaurus et qui peut-être customisé par l'utilisateur.</li>
|
||||
<li><strong>Fichier de configuration</strong>: Le fichier <code>website/siteConfig.js</code> est le principal fichier de configuration utilisé par Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="informations-de-preparation"></a><a href="#informations-de-preparation" 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>Informations de préparation</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/installation"><span class="arrow-prev">← </span><span>Installation</span></a><a class="docs-next button" href="/docs/fr/site-creation"><span>Création de votre site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#structure-de-fichiers">Structure de fichiers</a><ul class="toc-headings"><li><a href="#description-des-dossier">Description des dossier</a></li><li><a href="#fichiers-cle">Fichiers clé</a></li></ul></li><li><a href="#informations-de-preparation">Informations de préparation</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/fr/installation">Getting Started</a><a href="
|
||||
/docs/fr/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.10.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.10.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.10.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.10.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.10.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.10.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.11.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.11.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.11.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.11.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.11.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.11.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.9.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 전체 문서 파일의 구조와 순서 정보를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.9.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.9.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/1.9.x/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 전체 문서 파일의 구조와 순서 정보를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/1.9.x/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/1.9.x/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/next/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/next/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/next/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/next/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/next/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/next/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/ko" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ko/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><li><a href="#markdown-syntax">Markdown Syntax</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/ko/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ko/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
/docs/ko/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/ko" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ko/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><li><a href="#markdown-syntax">Markdown Syntax</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/ko/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ko/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
/docs/ko/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="디렉토리-구조"></a><a href="#디렉토리-구조" 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>디렉토리 구조</h2>
|
||||
<p><a href="/docs/ko/installation">설치된 도큐사우르스 </a>에서 살펴본 것처럼 설치 스크립트를 실행하고 나면 아래와 같은 디렉토리 구조가 생성됩니다.</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -107,20 +108,22 @@
|
|||
</code></pre>
|
||||
<h3><a class="anchor" aria-hidden="true" id="디렉토리-설명"></a><a href="#디렉토리-설명" 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>디렉토리 설명</h3>
|
||||
<ul>
|
||||
<li><strong>문서 소스 파일</strong>: <code>docs</code> 디렉토리에는 Markdown으로 작성된 예제 문서 파일들이 있습니다.</li>
|
||||
<li><strong>Documentation Source Files</strong>: The <code>docs</code> directory contains example documentation files written in Markdown.</li>
|
||||
<li><strong>블로그</strong>: <code>website/blog</code> 디렉토리에는 Markdown으로 작성된 블로그 포스팅 예제들이 있습니다.</li>
|
||||
<li><strong>페이지</strong>: <code>website/pages</code> 디렉토리에는 사이트 메인 페이지 예제 문서가 있습니다.</li>
|
||||
<li><strong>리소스 파일</strong>: <code>website/static</code> 디렉토리에는 예제 사이트에서 사용하는 리소스 파일이 있습니다.</li>
|
||||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="주요-파일"></a><a href="#주요-파일" 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>주요 파일</h3>
|
||||
<ul>
|
||||
<li><strong>푸터</strong>: <code>website/core/Footer.js</code> 파일은 도큐사우르스로 만드는 사이트의 푸터로 동작하는 리액트 컴포넌트입니다. 만들고자하는 사이트에 맞게 내용은 수정되어야 합니다.</li>
|
||||
<li><strong>설정 파일</strong>: <code>website/siteConfig.js</code> 파일은 도큐사우르스에서 사용하는 설정 파일입니다.</li>
|
||||
<li><strong>사이드바</strong>: <code>sidebars.json</code> 파일은 문서 파일들의 순서와 구조를 담고 있습니다.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="주의할-점"></a><a href="#주의할-점" 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>주의할 점</h2>
|
||||
<p>당신은 <code>website/siteConfig.js</code>와 <code>website/core/Footer.js</code> 파일들을 그대로 유지해도 되지만, 필요하다면 원하는대로 수정할 수도 있습니다. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 최소한 <code>website/pages</code>안에 <code>en/index.js</code> 또는 <code>en/index.html</code> 파일은 가지고 있어야 하며, 헤더 아이콘으로 사용할 이미지는 <code>website/static</code> 안에 있어야 합니다.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ko/installation"><span class="arrow-prev">← </span><span>설치</span></a><a class="docs-next button" href="/docs/ko/site-creation"><span>당신만의 사이트 만들기</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#디렉토리-구조">디렉토리 구조</a><ul class="toc-headings"><li><a href="#디렉토리-설명">디렉토리 설명</a></li><li><a href="#주요-파일">주요 파일</a></li></ul></li><li><a href="#주의할-점">주의할 점</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/ko/installation">Getting Started</a><a href="
|
||||
/docs/ko/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.10.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.10.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.10.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.10.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.10.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.10.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.11.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.11.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.11.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.11.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.11.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.11.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.9.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Barras laterais</strong>: O arquivo <code>sidebars.json</code> contém a estrutura e ordenação dos arquivos da documentação.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>Você vai precisar manter os arquivos <code>website/siteConfig.js</code> e <code>website/core/Footer.js</code>, mas pode editá-los como quiser. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. No mínimo, você precisa ter um arquivo <code>en/index.js</code> ou <code>en/index.html</code> dentro de <code>website/pages</code> e uma imagem para usar como seu ícone de cabeçalho dentro de <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.9.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.9.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/1.9.x/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Barras laterais</strong>: O arquivo <code>sidebars.json</code> contém a estrutura e ordenação dos arquivos da documentação.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>Você vai precisar manter os arquivos <code>website/siteConfig.js</code> e <code>website/core/Footer.js</code>, mas pode editá-los como quiser. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. No mínimo, você precisa ter um arquivo <code>en/index.js</code> ou <code>en/index.html</code> dentro de <code>website/pages</code> e uma imagem para usar como seu ícone de cabeçalho dentro de <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/1.9.x/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/1.9.x/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/next/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/next/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/next/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/next/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/next/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/next/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/pt-BR" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/pt-BR/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><li><a href="#markdown-syntax">Markdown Syntax</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/pt-BR/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/pt-BR/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
/docs/pt-BR/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/pt-BR" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/pt-BR/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><li><a href="#markdown-syntax">Markdown Syntax</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/pt-BR/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/pt-BR/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
/docs/pt-BR/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="estrutura-de-diretorios"></a><a href="#estrutura-de-diretorios" 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>Estrutura de diretórios</h2>
|
||||
<p>Como visto após você <a href="/docs/pt-BR/installation">instalar o Docusaurus</a>, o script de inicialização criou uma estrutura de diretórios semelhante a esta:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="arquivos-importantes"></a><a href="#arquivos-importantes" 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>Arquivos importantes</h3>
|
||||
<ul>
|
||||
<li><strong>Rodapé</strong>: O arquivo <code>website/core/Footer.js</code> é um componente React que atua como o rodapé do site gerado pelo Docusaurus e deve ser personalizado pelo usuário.</li>
|
||||
<li><strong>Arquivo de configuração</strong>: O arquivo <code>website/siteConfig.js</code> é o principal arquivo de configuração usado pelo Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="observacões-sobre-a-preparacão"></a><a href="#observacões-sobre-a-preparacão" 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>Observações sobre a preparação</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/pt-BR/installation"><span class="arrow-prev">← </span><span>Instalação</span></a><a class="docs-next button" href="/docs/pt-BR/site-creation"><span>Criando seu site</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#estrutura-de-diretorios">Estrutura de diretórios</a><ul class="toc-headings"><li><a href="#descricão-dos-diretorios">Descrição dos diretórios</a></li><li><a href="#arquivos-importantes">Arquivos importantes</a></li></ul></li><li><a href="#observacões-sobre-a-preparacão">Observações sobre a preparação</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/pt-BR/installation">Getting Started</a><a href="
|
||||
/docs/pt-BR/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.10.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.10.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.10.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.10.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.10.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.10.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.11.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.11.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.11.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.11.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.11.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.11.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.9.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Боковые панели</strong>: Файл <code>sidebars.json</code> отражает структуру и порядок файлов документации.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>Вам следует сохранить файлы <code>website/siteConfig.js</code> и <code>website/core/Footer.js</code> в составе проекта, но вы можете отредактировать их по своему желанию. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. Также вам как минимум следует иметь файл <code>en/index.js</code> или <code>en/index.html</code> внутри каталога <code>website/pages</code> и изображение, используемое как иконка-значок в шапке вашего сайта в каталоге <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.9.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.9.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/1.9.x/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Боковые панели</strong>: Файл <code>sidebars.json</code> отражает структуру и порядок файлов документации.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>Вам следует сохранить файлы <code>website/siteConfig.js</code> и <code>website/core/Footer.js</code> в составе проекта, но вы можете отредактировать их по своему желанию. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. Также вам как минимум следует иметь файл <code>en/index.js</code> или <code>en/index.html</code> внутри каталога <code>website/pages</code> и изображение, используемое как иконка-значок в шапке вашего сайта в каталоге <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/1.9.x/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/1.9.x/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/next/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/next/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/next/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/next/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/next/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/next/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/ru" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ru/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><li><a href="#markdown-syntax">Markdown Syntax</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/ru/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ru/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
/docs/ru/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/ru" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ru/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><li><a href="#markdown-syntax">Markdown Syntax</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/ru/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/ru/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
/docs/ru/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="структура-каталогов"></a><a href="#структура-каталогов" 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>Структура каталогов</h2>
|
||||
<p>Как было показано после <a href="/docs/ru/installation">установки Docusaurus</a>, сценарий инициализации создал примерно такую структуру каталогов:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="ключевые-файлы"></a><a href="#ключевые-файлы" 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>Ключевые файлы</h3>
|
||||
<ul>
|
||||
<li><strong>Футер</strong>: Файл <code>website/core/Footer.js</code> является компонентом React, определяющим футер сайта, который создает Docusaurus, и должен быть настроен пользователем.</li>
|
||||
<li><strong>Файл настроек</strong>: Файл <code>website/siteConfig.js</code> является основным файлом настроек, используемых Docusaurus.</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="подготовка"></a><a href="#подготовка" 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>Подготовка</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. Значение поля <code>customDocsPath</code> в <code>website/siteConfig.js</code> может быть изменено по вашему желанию для использования другого наименования каталога или пути. Каталог <code>website</code> также может быть переименован во что угодно при необходимости.</p>
|
||||
<p>Тем не менее, вам следует сохранить каталоги <code>website/pages</code> и <code>website/static</code>. Вы можете изменить их содержимое по своему желанию. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/installation"><span class="arrow-prev">← </span><span>Установка</span></a><a class="docs-next button" href="/docs/ru/site-creation"><span>Создание вашего сайта</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#структура-каталогов">Структура каталогов</a><ul class="toc-headings"><li><a href="#описание-каталогов">Описание каталогов</a></li><li><a href="#ключевые-файлы">Ключевые файлы</a></li></ul></li><li><a href="#подготовка">Подготовка</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/ru/installation">Getting Started</a><a href="
|
||||
/docs/ru/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.10.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.10.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.11.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.11.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>工具栏</strong>：<code>sidebars.json</code> 文件包含文档文件的结构与排序。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>您不能删除 <code>website/siteConfig.js</code> 和 <code>website/core/Footer.js</code> 文件, 但可以按您的意愿编辑它们。 The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 在 <code>website/pages</code> 目录，你至少应该有一个 <code>en/index.js</code> 或 <code>en/index.html</code> 以及在<code>website/static</code>里有一个图片作为您的页眉图标(header icon) 。</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.9.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>工具栏</strong>：<code>sidebars.json</code> 文件包含文档文件的结构与排序。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and ordering of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>您不能删除 <code>website/siteConfig.js</code> 和 <code>website/core/Footer.js</code> 文件, 但可以按您的意愿编辑它们。 The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. 在 <code>website/pages</code> 目录，你至少应该有一个 <code>en/index.js</code> 或 <code>en/index.html</code> 以及在<code>website/static</code>里有一个图片作为您的页眉图标(header icon) 。</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.9.x/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/next/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/next/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/next/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/next/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/next/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/next/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/zh-CN" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/zh-CN/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><li><a href="#markdown-syntax">Markdown Syntax</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/zh-CN/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/zh-CN/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
/docs/zh-CN/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -82,9 +82,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/zh-CN" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Create Pages</h1></header><article><div><span><p>In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.</p>
|
||||
<p><img alt="Docusaurus MacBook" src="/img/undraw_docusaurus_tree.svg" class="docImage" /></p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="creating-a-regular-page"></a><a href="#creating-a-regular-page" 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>Creating a Regular Page</h2>
|
||||
<h2><a class="anchor" aria-hidden="true" id="create-a-regular-page"></a><a href="#create-a-regular-page" 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>Create a Regular Page</h2>
|
||||
<ol>
|
||||
<li><p>Go into the <code>pages/en</code> directory and create a file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<li><p>In the <code>website/pages/en</code> directory of your repository, save a text file called <code>hello-world.js</code> with the following contents:</p>
|
||||
<p>const React = require('react');</p>
|
||||
<p>const CompLibrary = require('../../core/CompLibrary.js');</p>
|
||||
<p>const Container = CompLibrary.Container;
|
||||
|
|
@ -101,9 +101,12 @@ return (
|
|||
}</p>
|
||||
<p>module.exports = HelloWorld;</p></li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Use any text editor to make the file, such as <a href="https://code.visualstudio.com/download">Microsoft Visual Studio Code</a> or <a href="https://www.activestate.com/komodo-edit">Komodo Edit</a>.</p>
|
||||
</blockquote>
|
||||
<ol start="2">
|
||||
<li>Go to <a href="http://localhost:3000/hello-world">http://localhost:3000/hello-world</a> and you should be able to see the new page.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.</li>
|
||||
<li>Change the text within the <code><p>...</p></code> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-diff"><span class="hljs-deletion">- <p>This is my first page!</p></span>
|
||||
<span class="hljs-addition">+ <p>I can write JSX here!</p></span>
|
||||
|
|
@ -154,7 +157,7 @@ id sem consectetuer libero luctus adipiscing.</p>
|
|||
</ol>
|
||||
<p>You've created your first documentation page on Docusaurus!</p>
|
||||
<p>Learn more about creating docs pages <a href="navigation">here</a>.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/zh-CN/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><li><a href="#markdown-syntax">Markdown Syntax</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/zh-CN/next/tutorial-create-new-site"><span class="arrow-prev">← </span><span>Create a New Site</span></a><a class="docs-next button" href="/docs/zh-CN/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="#create-a-regular-page">Create a Regular Page</a></li><li><a href="#create-a-documentation-page">Create a Documentation Page</a></li><li><a href="#markdown-syntax">Markdown Syntax</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
/docs/zh-CN/translation">Localization</a><a href="
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -131,14 +131,14 @@ v8.15.1
|
|||
<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="7">
|
||||
<li><code>cd</code> to the directory for the local clone.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="install-the-docusaurus-init-command"></a><a href="#install-the-docusaurus-init-command" 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>Install the Docusaurus init command</h2>
|
||||
<p>Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!</p>
|
||||
<ol>
|
||||
<li><code>cd</code> to the directory of your local repository.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> docusaurus-tutorial
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li>Run the following command:</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="目录结构"></a><a href="#目录结构" 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>目录结构</h2>
|
||||
<p>正如<a href="/docs/zh-CN/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
|
||||
<pre><code class="hljs css language-bash">root-directory
|
||||
├── .gitignore
|
||||
├── docs
|
||||
│ ├── doc1.md
|
||||
│ ├── doc2.md
|
||||
|
|
@ -114,13 +115,15 @@
|
|||
</ul>
|
||||
<h3><a class="anchor" aria-hidden="true" id="关键文件"></a><a href="#关键文件" 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>关键文件</h3>
|
||||
<ul>
|
||||
<li><strong>页脚</strong>：<code>website/core/Footer.js</code> 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。</li>
|
||||
<li><strong>配置文件</strong>：<code>website/siteConfig.js</code> 文件是 Docusaurus 的主配置文件。</li>
|
||||
<li><strong>Footer</strong>: The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||||
<li><strong>Configuration file</strong>: The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||||
<li><strong>Sidebars</strong>: The <code>sidebars.json</code> file contains the structure and order of the documentation files.</li>
|
||||
<li><strong>.gitignore</strong>: The <code>.gitignore</code> file lists the necessary ignore files for the generated site so that they do not get added to the git repo.</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="准备说明"></a><a href="#准备说明" 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>准备说明</h2>
|
||||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files but may edit them as you wish. The value of the <code>customDocsPath</code> key in <code>website/siteConfig.js</code> can be modified if you wish to use a different directory name or path. The <code>website</code> directory can also be renamed to anything you want it to be.</p>
|
||||
<p>However, you should keep the <code>website/pages</code> and <code>website/static</code> directories. You may change the content inside them as you wish. At the bare minimum, you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||||
<p>If your directory does not yet have a <code>.gitignore</code>, we generate it with the necessary ignored files listed. As a general rule, you should ignore all <code>node_modules</code>, build files, system files (<code>.DS_Store</code>), logs, etc. <a href="https://github.com/github/gitignore/blob/master/Node.gitignore">Here</a> is a more comprehensive list of what is normally ignored for Node.js projects.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/installation"><span class="arrow-prev">← </span><span>安装</span></a><a class="docs-next button" href="/docs/zh-CN/site-creation"><span>创建你的站点</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#目录结构">目录结构</a><ul class="toc-headings"><li><a href="#目录介绍">目录介绍</a></li><li><a href="#关键文件">关键文件</a></li></ul></li><li><a href="#准备说明">准备说明</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/zh-CN/installation">Getting Started</a><a href="
|
||||
/docs/zh-CN/versioning">Versioning</a><a href="
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue