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

Deploy website

Browse source 
Deploy website version based on 92729af0ab
This commit is contained in:
Website Deployment Script 2020-04-08 17:25:17 +00:00
parent 3ae1a2efc2
commit e711ec8c37
29 changed files with 461 additions and 461 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/zh-CN/1.10.x/installation.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/1.10.x/installation/index.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.10.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

22
docs/zh-CN/1.10.x/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.10.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.10.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.10.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.10.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.10.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.10.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/1.10.x/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.10.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.10.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.10.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.10.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.10.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.10.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.10.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

44
docs/zh-CN/1.11.x/installation.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/1.11.x/installation/index.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.11.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

22
docs/zh-CN/1.11.x/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.11.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.11.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.11.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.11.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.11.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.11.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/1.11.x/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.11.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.11.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.11.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.11.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.11.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.11.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.11.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

44
docs/zh-CN/1.12.0/installation.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.12.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.12.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/1.12.0/installation/index.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.12.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.12.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

22
docs/zh-CN/1.12.0/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.12.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.12.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.12.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.12.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.12.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.12.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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.12.0/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
<p>正如<a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/1.12.0/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.12.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.12.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.12.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.12.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.12.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.12.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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.12.0/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
<p>正如<a href="/docs/zh-CN/1.12.0/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

44
docs/zh-CN/1.13.0/installation.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.13.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.13.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/1.13.0/installation/index.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.13.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.13.0/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

22
docs/zh-CN/1.13.0/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.13.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.13.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.13.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.13.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.13.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.13.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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.13.0/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
<p>正如<a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/1.13.0/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.13.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.13.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.13.0/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.13.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.13.0"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.13.0/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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.13.0/installation">安装 Docusaurus</a>后所示, 初始化脚本创建了一个类似于以下内容的目录结构:</p>
<p>正如<a href="/docs/zh-CN/1.13.0/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

44
docs/zh-CN/1.9.x/installation.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/1.9.x/installation/index.html
View file

@ -82,24 +82,24 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Installation</h1></header><article><div><span><p>Docusaurus 的设计理念，最一开始就是要易于安装和使用，让你的网站可以快速架好并运行起来。</p>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus"></a><a href="#安装-docusaurus" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Docusaurus</h2>
<p>我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:</p>
<p>我们为你归纳了一个简单的操作流程，它包括了建立 Docusaurus 站点基础架构需要执行的所有操作：</p>
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>您必须有 Node &gt; = 8. x 与 Yarn &gt; = 1.5。</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -126,22 +126,22 @@
└── static
</code></pre>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/1.9.x/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

20
docs/zh-CN/1.9.x/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.9.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.9.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.9.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.9.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.9.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.9.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>页脚</strong>：文件 <code>website/core/Footer.js</code> 是一个 React 组件，用于生成 Docusaurus 站点的页脚，内容应由用户定制。</li>
<li><strong>配置文件</strong>：文件 <code>website/siteConfig.js</code> 是 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>
<li><strong>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

20
docs/zh-CN/1.9.x/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/1.9.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.9.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/1.9.x/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/1.9.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.9.x"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/1.9.x/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/1.9.x/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>页脚</strong>：文件 <code>website/core/Footer.js</code> 是一个 React 组件，用于生成 Docusaurus 站点的页脚，内容应由用户定制。</li>
<li><strong>配置文件</strong>：文件 <code>website/siteConfig.js</code> 是 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>
<li><strong>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

44
docs/zh-CN/installation.html
View file

@ -89,20 +89,20 @@
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>You have to be on Node &gt;= 8.x and Yarn &gt;= 1.5.</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -129,25 +129,25 @@
└── static
</code></pre>
<blockquote>
<p>This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the <a href="https://docs.docker.com/">Docker documentation</a>.</p>
<p>安装过程自动创建了一些 Docker 文件，这些文件并不是运行 Docusaurus 所必须的。 若要节省空间，可以把它们删掉，这并不会导致任何问题出现。 有关 Docker 的更多信息，请参阅 <a href="https://docs.docker.com/">Docker 文档</a>。</p>
</blockquote>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
<span class="hljs-keyword">Using</span> globally installed <span class="hljs-keyword">version</span> <span class="hljs-keyword">of</span> Yarn
yarn outdated v1<span class="hljs-number">.5</span><span class="hljs-number">.1</span>
@ -162,18 +162,18 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
✨ Done <span class="hljs-keyword">in</span> <span class="hljs-number">0.41</span>s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn<span class="hljs-built_in"> upgrade </span>docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs"><span class="hljs-built_in">npm</span> update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/installation/index.html
View file

@ -89,20 +89,20 @@
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>You have to be on Node &gt;= 8.x and Yarn &gt;= 1.5.</p>
<p>Node 版本应不低于 8.x，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -129,25 +129,25 @@
└── static
</code></pre>
<blockquote>
<p>This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the <a href="https://docs.docker.com/">Docker documentation</a>.</p>
<p>安装过程自动创建了一些 Docker 文件，这些文件并不是运行 Docusaurus 所必须的。 若要节省空间，可以把它们删掉，这并不会导致任何问题出现。 有关 Docker 的更多信息，请参阅 <a href="https://docs.docker.com/">Docker 文档</a>。</p>
</blockquote>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
<span class="hljs-keyword">Using</span> globally installed <span class="hljs-keyword">version</span> <span class="hljs-keyword">of</span> Yarn
yarn outdated v1<span class="hljs-number">.5</span><span class="hljs-number">.1</span>
@ -162,18 +162,18 @@ docusaurus <span class="hljs-number">1.0</span><span class="hljs-number">.9</spa
✨ Done <span class="hljs-keyword">in</span> <span class="hljs-number">0.41</span>s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn<span class="hljs-built_in"> upgrade </span>docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs"><span class="hljs-built_in">npm</span> update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/next/installation.html
View file

@ -89,20 +89,20 @@
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>You have to be on Node &gt;= 10.9.0 and Yarn &gt;= 1.5.</p>
<p>Node 版本应不低于 10.9.0，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -129,25 +129,25 @@
└── static
</code></pre>
<blockquote>
<p>This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the <a href="https://docs.docker.com/">Docker documentation</a>.</p>
<p>安装过程自动创建了一些 Docker 文件，这些文件并不是运行 Docusaurus 所必须的。 若要节省空间，可以把它们删掉，这并不会导致任何问题出现。 有关 Docker 的更多信息，请参阅 <a href="https://docs.docker.com/">Docker 文档</a>。</p>
</blockquote>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -162,18 +162,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/next/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/next/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

44
docs/zh-CN/next/installation/index.html
View file

@ -89,20 +89,20 @@
<ol>
<li><p>确保你已经安装了最新版的 <a href="https://nodejs.org/en/download/">Node</a>。 此外我们建议你再装个 <a href="https://yarnpkg.com/en/docs/install">Yarn</a>。</p>
<blockquote>
<p>You have to be on Node &gt;= 10.9.0 and Yarn &gt;= 1.5.</p>
<p>Node 版本应不低于 10.9.0，Yarn 版本应不低于 1.5。</p>
</blockquote></li>
<li><p>Create a project, if none exists, and change your directory to this project's root.</p>
<p>文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录：<code>docs</code>和<code>website</code>。</p>
<li><p>如果没有已经创建好的 Docusaurus 项目，则新建一个目录作为新项目的根目录，然后进入其中。</p>
<p>你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录：<code>docs</code> 和 <code>website</code>。</p>
<blockquote>
<p>通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。</p>
<p>一般来说，把 Docusaurus 站点文件，存放在已有的或新建的 GitHub 项目目录下，是个不错的选择，不过 Docusaurus 并不强制要求你这样做。</p>
</blockquote></li>
<li><p>运行 Docusaurus 的安装脚本：<code>npx docusaurus-init</code>。</p>
<li><p>运行 Docusaurus 安装脚本：<code>npx docusaurus-init</code>。</p>
<blockquote>
<p>如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 安装完成后，运行 <code>docusaurus-init</code>。</p>
<p>如果你没有安装 Node 8.2 +，或是希望全局安装 Docusaurus，执行命令 <code>yarn global add docusaurus-init</code> 或 <code>npm install --global docusaurus-init</code>。 然后，执行命令 <code>docusaurus-init</code>。</p>
</blockquote></li>
</ol>
<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>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<p>加上前面提到的几个文件和目录，现在你的 Docusaurus 项目的目录结构应该看起来像这个样子：</p>
<pre><code class="hljs css language-bash">root-directory
├── Dockerfile
├── README.md
@ -129,25 +129,25 @@
└── static
</code></pre>
<blockquote>
<p>This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the <a href="https://docs.docker.com/">Docker documentation</a>.</p>
<p>安装过程自动创建了一些 Docker 文件，这些文件并不是运行 Docusaurus 所必须的。 若要节省空间，可以把它们删掉，这并不会导致任何问题出现。 有关 Docker 的更多信息，请参阅 <a href="https://docs.docker.com/">Docker 文档</a>。</p>
</blockquote>
<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="#installing-docusaurus">Installation</a> 部分所述运行 Docusaurus 的初始化脚本 <code>docusaurus-init</code> 后，你将会有一个可运行的示例网站。 要运行这个示例：</p>
<p>在执行完<a href="#安装-docusaurus">安装 Docusaurus </a>一节中提到的 Docusaurus 初始化脚本<code>docusaurus-init</code> 之后，你会得到一个能够正常运行的示例网站，你可以基于它来建设自己的站点。 要运行这个示例：</p>
<ol>
<li><p><code>cd website</code></p></li>
<li><p>在 <code>website</code> 目录下，启动Docusaurus服务器：<code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果没有自动打开已启动的示例网站，请从 <a href="http://localhost:3000">http://localhost:3000</a> 访问示例站点。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the <code>website</code> directory will cause the page to refresh. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。</p></li>
<li><p>在 <code>website</code> 目录下，启动 Docusaurus 本地服务器，通过执行命令 <code>yarn start</code> 或 <code>npm start</code>。</p></li>
<li><p>如果示例站点没有自动打开，可以从 <a href="http://localhost:3000">http://localhost:3000</a> 访问它。 如果 3000 端口已被占用，将使用另一个端口。 查看控制台消息以确认使用了哪个端口。</p>
<p>现在，你应该已经看到了浏览器中加载的示例站点。 与此同时，还有一个 LiveReload 服务也在运行，你对 <code>website</code> 目录中的文档和文件进行任何更改，都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。</p></li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
<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>
<p>If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the <code>NO_PROXY</code> environment variable.</p>
<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>
<p>如果你使用了代理软件，那么你需要先禁用它，这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 <code>NO_PROXY</code> 环境变量来完成。</p>
<pre><code class="hljs css language-sh">SET NO_PROXY=localhost
yarn start (or npm run start)
yarn start （或 npm run start）
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="updating-your-docusaurus-version"></a><a href="#updating-your-docusaurus-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Updating Your Docusaurus Version</h2>
<p>在 Docusaurus 安装之后，你可以在 <code>website</code> 目录下查看最新版本，或是输入 <code>yarn outdated docusaurus</code> 或 <code>npm outdated docusaurus</code> 查看。</p>
<p>You will see something like this:</p>
<h2><a class="anchor" aria-hidden="true" id="更新你的-docusaurus-版本"></a><a href="#更新你的-docusaurus-版本" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>更新你的 Docusaurus 版本</h2>
<p>安装好 Docusaurus 之后，你可以查看当前 Docusaurus 的版本号，通过在 <code>website</code> 目录下执行命令 <code>yarn outdated docusaurus</code> 或者 <code>npm outdated docusaurus</code>。</p>
<p>你会看到类似这样的输出结果：</p>
<pre><code class="hljs">$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@ -162,18 +162,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
</code></pre>
<blockquote>
<p>如果 <code>outdated</code> 命令没有任何版本过期的通知，那你就处于最新版本。</p>
<p>如果执行 <code>outdated</code> 命令后，输出结果中没有重要版本更新提示，就意味着你正在使用的是最新版本。</p>
</blockquote>
<p>You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by:</p>
<p>你可以将 Docusaurus 更新到<a href="https://www.npmjs.com/package/docusaurus">最新版本</a>，通过执行命令：</p>
<pre><code class="hljs">yarn upgrade docusaurus --latest
</code></pre>
<p>或</p>
<pre><code class="hljs">npm update docusaurus
</code></pre>
<blockquote>
<p>如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 <a href="https://babeljs.io/docs/en/babel-register/#environment-variables">temporary directory</a>，或是在 <code>BABEL_DISABLE_CACHE=1</code> 的配置下运行 Docusaurus 服务（如：<code>yarn start</code>）。</p>
<p>如果在升级之后你遇到了某些错误，可以试着清空你的 Babel 缓存（通常位于<a href="https://babeljs.io/docs/en/babel-register/#environment-variables">临时目录</a>），或试着在设置了 <code>BABEL_DISABLE_CACHE=1</code> 的情况下启动 Docusaurus 服务器（例如，通过执行命令 <code>yarn start</code>）。</p>
</blockquote>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/next/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理启动服务">使用代理启动服务</a></li></ul></li><li><a href="#updating-your-docusaurus-version">Updating Your Docusaurus Version</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/next/site-preparation"><span>建站准备</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-docusaurus">安装 Docusaurus</a></li><li><a href="#验证安装">验证安装</a></li><li><a href="#运行示例网站">运行示例网站</a><ul class="toc-headings"><li><a href="#使用代理软件后启动本地服务器">使用代理软件后启动本地服务器</a></li></ul></li><li><a href="#更新你的-docusaurus-版本">更新你的 Docusaurus 版本</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="

22
docs/zh-CN/next/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>建站准备 · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/next/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="建站准备 · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/next/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>建站准备 · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/next/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="建站准备 · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/next/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">建站准备</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/next/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">建站准备</h1></header><article><div><span><p><a href="/docs/zh-CN/next/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/next/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/next/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>建站准备 · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/next/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="建站准备 · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/next/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>建站准备 · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/next/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="建站准备 · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/next/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">建站准备</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/next/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">建站准备</h1></header><article><div><span><p><a href="/docs/zh-CN/next/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/next/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/site-preparation.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

22
docs/zh-CN/site-preparation/index.html
View file

@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="在 [安装 Docusaurus](/docs/zh-CN/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="在 [安装 Docusaurus](/docs/zh-CN/installation)之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="[安装 Docusaurus](/docs/zh-CN/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="[安装 Docusaurus](/docs/zh-CN/installation) 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
@ -80,9 +80,9 @@
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p>在 <a href="/docs/zh-CN/installation">安装 Docusaurus</a>之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
</script></nav></div><div class="container mainContainer docsContainer"><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 id="__docusaurus" class="postHeaderTitle">Site Preparation</h1></header><article><div><span><p><a href="/docs/zh-CN/installation">安装 Docusaurus</a> 后，你现在有了一个可以为具体的网站服务的框架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。</p>
<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>
<p>正如<a href="/docs/zh-CN/installation">安装 Docusaurus</a> 后所示, 初始化脚本创建了一个目录结构，其类似于：</p>
<pre><code class="hljs css language-bash">root-directory
├── .gitignore
├── docs
@ -108,17 +108,17 @@
</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>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>页面</strong>：包含示例网站顶级页面的文件夹 <code>website/pages</code>。</li>
<li><strong>静态资源与图片</strong>：包含供网站使用的静态资源文件夹 <code>website/static</code>。</li>
<li><strong>文档源文件</strong>：目录 <code>docs</code> 下包含了用 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>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>
<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>.gitignore</strong>: 文件 <code>.gitignore</code> 中列出了在生成的 Docusaurus 站点中应该被忽略的文件，这样它们就不会被添加到 git 仓库中。</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>

2
zh-CN/index.html
View file

File diff suppressed because one or more lines are too long