mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-14 09:37:37 +02:00
Website Deployment Script
parent
0797ae0921
commit
ffbd59d4e2
266 changed files with 2418 additions and 2418 deletions
|
|
@ -84,44 +84,44 @@
|
|||
<p>别名︰ <code>build</code>。</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Options</th><th>Default</th><th>Description</th></tr>
|
||||
<tr><th>可选项</th><th>默认</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>--skip-image-compression</code></td><td><code>false</code></td><td>Skip compression of image assets. You usually won't want to skip this unless your images have already been optimized.</td></tr>
|
||||
<tr><td><code>--skip-image-compression</code></td><td><code>false</code></td><td>忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.</p>
|
||||
<p>See also <a href="/docs/zh-CN/commands#docusaurus-start"><code>docusaurus-start</code></a>.</p>
|
||||
<p>生成静态站点，必要时会应用翻译。 适用于部署前构建站点。</p>
|
||||
<p>另请参阅 <a href="/docs/zh-CN/commands#docusaurus-start"><code>docusaurus-start</code></a>。</p>
|
||||
<hr>
|
||||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-examples"></a><a href="#docusaurus-examples" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docusaurus-examples</code></h3>
|
||||
<p>别名：<code>examples</code></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Arguments</th><th>Default</th><th>Description</th></tr>
|
||||
<tr><th>参数</th><th>默认</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code><feature></code></td><td>-</td><td>Specify a feature <code>translations</code> or <code>versions</code> to generate the extra example files for that feature.</td></tr>
|
||||
<tr><td><code><feature></code></td><td>-</td><td>指定附加功能 <code>translations</code> 或 <code>versions</code>，以生成附加功能的额外文件。</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Example</strong></p>
|
||||
<p><strong>示例</strong></p>
|
||||
<pre><code class="hljs css language-bash">docusaurus-examples <feature>
|
||||
</code></pre>
|
||||
<p>When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the <a href="/docs/zh-CN/site-preparation">Site Preparation guide</a>.</p>
|
||||
<p>如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 <a href="/docs/zh-CN/site-preparation">Site Preparation guide</a> 中会深入介绍此命令。</p>
|
||||
<hr>
|
||||
<h3><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><code>docusaurus-发布</code></h3>
|
||||
<p>Alias: <code>publish-gh-pages</code></p>
|
||||
<p><a href="/docs/zh-CN/commands#docusaurus-build">Builds</a>, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined:</p>
|
||||
<p>The following environment variables are generally set manually by the user in the CircleCI <code>config.yml</code> file.</p>
|
||||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-publish"></a><a href="#docusaurus-publish" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docusaurus-publish</code></h3>
|
||||
<p>别名: <code>publish-gh-pages</code></p>
|
||||
<p><a href="/docs/zh-CN/commands#docusaurus-build">Builds</a>，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle CI 部署步骤中运行，因此需要定义一些环境变量：</p>
|
||||
<p>以下环境变量通常由用户在 CircleCI 的 <code>config.yml</code> 文件中手动设置。</p>
|
||||
<ul>
|
||||
<li><code>GIT_USER</code>: 与部署提交联系的 GIT 用户。</li>
|
||||
<li><code>GIT_USER</code>：与部署相关的 GIT 用户。</li>
|
||||
<li><code>USE_SSH</code>: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.</li>
|
||||
</ul>
|
||||
<p><strong>Example</strong></p>
|
||||
<p><strong>示例</strong></p>
|
||||
<pre><code class="hljs css language-bash">GIT_USER=docusaurus-bot USE_SSH=<span class="hljs-literal">true</span> yarn run publish-gh-pages
|
||||
</code></pre>
|
||||
<p>The following environment variables are <a href="https://circleci.com/docs/1.0/environment-variables/">set by CircleCI</a> during the build process.</p>
|
||||
<ul>
|
||||
<li><code>CIRCLE_BRANCH</code>: 与触发 CI 运行的提交关联的 git 分支。</li>
|
||||
<li><code>CIRCLE_BRANCH</code>：与触发 CI 运行的 commit 相关联的 git 分支。</li>
|
||||
<li><code>CI_PULL_REQUEST</code>: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。</li>
|
||||
</ul>
|
||||
<p>The following should be set by you in <code>siteConfig.js</code> as <code>organizationName</code> and <code>projectName</code>, respectively. If they are not set in your site configuration, they fall back to the <a href="https://circleci.com/docs/1.0/environment-variables/">CircleCI environment</a>.</p>
|
||||
|
|
@ -136,14 +136,14 @@
|
|||
<p>Renames an existing version of the docs to a new version name.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Arguments</th><th>Default</th><th>Description</th></tr>
|
||||
<tr><th>参数</th><th>默认</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code><currentVersion></code></td><td>-</td><td>Version to be renamed.</td></tr>
|
||||
<tr><td><code><newVersion></code></td><td>-</td><td>Version to be renamed to.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Example</strong></p>
|
||||
<p><strong>示例</strong></p>
|
||||
<pre><code class="hljs css language-bash">docusaurus-rename-version <currentVersion> <newVersion>
|
||||
</code></pre>
|
||||
<p>See the <a href="/docs/zh-CN/versioning#renaming-existing-versions">Versioning guide</a> to learn more.</p>
|
||||
|
|
@ -153,7 +153,7 @@
|
|||
<p>This command will build the static website, apply translations if necessary, and then start a local server.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Options</th><th>Default</th><th>Description</th></tr>
|
||||
<tr><th>可选项</th><th>默认</th><th>说明</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>--port <number></code></td><td><code>3000</code></td><td>The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.</td></tr>
|
||||
|
|
@ -172,7 +172,7 @@
|
|||
<h3><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><code>docusaurus-书写-翻译</code></h3>
|
||||
<p>Alias: <code>write-translations</code></p>
|
||||
<p>Writes the English for any strings that need to be translated into an <code>website/i18n/en.json</code> file. The script will go through every file in <code>website/pages/en</code> and through the <code>siteConfig.js</code> file and other config files to fetch English strings that will then be translated on Crowdin. See the <a href="/docs/zh-CN/translation">Translation guide</a> to learn more.</p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/versioning"><span class="arrow-prev">← </span><span>Versioning</span></a><a class="docs-next button" href="/docs/zh-CN/doc-markdown"><span>Markdown Features</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#从命令行运行">从命令行运行</a></li><li><a href="#使用参数">使用参数</a></li><li><a href="#配置">配置</a></li><li><a href="#命令">命令</a></li><li><a href="#参考">参考</a><ul class="toc-headings"><li><a href="#docusaurus-build"><code>docusaurus-build</code></a></li><li><a href="#docusaurus-examples"><code>docusaurus-examples</code></a></li><li><a href="#docusaurus-发布"><code>docusaurus-发布</code></a></li><li><a href="#docusaurus-rename-version"><code>docusaurus-rename-version</code></a></li><li><a href="#docusaurus-start"><code>docusaurus-start</code></a></li><li><a href="#docusaurus-版本-版本"><code>docusaurus-版本</code></a></li><li><a href="#docusaurus-书写-翻译"><code>docusaurus-书写-翻译</code></a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/versioning"><span class="arrow-prev">← </span><span>Versioning</span></a><a class="docs-next button" href="/docs/zh-CN/doc-markdown"><span>Markdown Features</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#从命令行运行">从命令行运行</a></li><li><a href="#使用参数">使用参数</a></li><li><a href="#配置">配置</a></li><li><a href="#命令">命令</a></li><li><a href="#参考">参考</a><ul class="toc-headings"><li><a href="#docusaurus-build"><code>docusaurus-build</code></a></li><li><a href="#docusaurus-examples"><code>docusaurus-examples</code></a></li><li><a href="#docusaurus-publish"><code>docusaurus-publish</code></a></li><li><a href="#docusaurus-rename-version"><code>docusaurus-rename-version</code></a></li><li><a href="#docusaurus-start"><code>docusaurus-start</code></a></li><li><a href="#docusaurus-版本-版本"><code>docusaurus-版本</code></a></li><li><a href="#docusaurus-书写-翻译"><code>docusaurus-书写-翻译</code></a></li></ul></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="
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue