mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-12 16:47:26 +02:00
158 lines
No EOL
25 KiB
HTML
158 lines
No EOL
25 KiB
HTML
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CLI Commands · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta property="og:title" content="CLI Commands · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 ` run ` 命令调用这些脚本。 一些常见的命令如下:"/><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)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-44373548-31', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-blocks-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||
document.addEventListener("DOMContentLoaded", function(){
|
||
addBackToTop(
|
||
{"zIndex":100}
|
||
)
|
||
});
|
||
</script><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible doc separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/zh-CN"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/zh-CN/versions.html"><h3>1.1.5</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/zh-CN/installation" target="_self">文档</a></li><li class=""><a href="/zh-CN/help" target="_self">帮助</a></li><li class=""><a href="/zh-CN/users" target="_self">Users</a></li><li class=""><a href="/zh-CN/about-slash" target="_self">About /</a></li><li class=""><a href="/blog" target="_self">博客</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg"/>简体中文</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/en">English</a></li><li><a href="/es-ES">Español</a></li><li><a href="/ro">Română</a></li><li><a href="/tr">Türkçe</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script>
|
||
const languagesMenuItem = document.getElementById("languages-menu");
|
||
const languagesDropDown = document.getElementById("languages-dropdown");
|
||
languagesMenuItem.addEventListener("click", function(){
|
||
if(languagesDropDown.className == "hide") {
|
||
languagesDropDown.className = "visible";
|
||
} else {
|
||
languagesDropDown.className = "hide";
|
||
}
|
||
});
|
||
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>API</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>快速起步</h3><ul><li class="navListItem"><a class="navItem" href="/docs/zh-CN/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/site-preparation">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/publishing">Publishing your site</a></li></ul></div><div class="navGroup navGroupActive"><h3>教程</h3><ul><li class="navListItem"><a class="navItem" href="/docs/zh-CN/blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/translation">翻译和本地化</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/versioning">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/zh-CN/commands">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/api-pages">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/site-config">siteConfig.js</a></li></ul></div></div></section></div><script>
|
||
var toggler = document.getElementById('navToggler');
|
||
var nav = document.getElementById('docsNav');
|
||
toggler.onclick = function() {
|
||
nav.classList.toggle('docsSliderActive');
|
||
};
|
||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/zh-CN" target="_blank" rel="noreferrer noopener">Translate</a><h1>CLI Commands</h1></header><article><div><span><p>Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 <code>run</code> 命令调用这些脚本。 一些常见的命令如下:</p>
|
||
<ul>
|
||
<li><a href="/docs/zh-CN/commands#docusaurus-start-port-number"> <code>yarn run star</code> </a>: 从本地服务器生成并且维护这个网站</li>
|
||
<li><a href="/docs/zh-CN/commands#docusaurus-examples"> <code>yarn run examples</code> </a>: 创建示例配置文件</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>这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 <code>start</code> 命令。 这是这样的命令,：它告诉 Docusaurus 运行 <code>Docusaurus-start</code> 脚本, 它生成站点并启动服务器, 通常是这样调用的:</p>
|
||
<pre><code class="hljs css bash">yarn run start
|
||
</code></pre>
|
||
<p>也可以使用 npm 调用相同的脚本:</p>
|
||
<pre><code class="hljs css bash">npm run start
|
||
</code></pre>
|
||
<p>若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 <code>start</code> 命令。</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>Some commands support optional arguments. For example, to start a server on port 8080, you can specify the <code>--port</code> argument when running <code>start</code>:</p>
|
||
<pre><code class="hljs css bash">yarn run start -- port 8080
|
||
</code></pre>
|
||
<p>如果使用 npm 运行 Docusaurus, 则仍然可以通过在 <code>npm run <command></code> 和命令参数之间插入 <code>--</code> 来使用命令行参数:</p>
|
||
<pre><code class="hljs css bash">npm run start -- --port 8080
|
||
</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>这些脚本是在 <code>website/package.json</code> 文件的 <code>"scripts"</code> 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 <a href="/docs/zh-CN/installation"> 安装指南 </a>。</p>
|
||
<p>Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 <code>yarn run start</code> 或 <code>npm start</code> 来实现相同的目的, 而不是每次都键入 <code>docusaurus-start</code>。</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><autogenerated_table_of_contents></p>
|
||
<hr>
|
||
<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>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-build"></a><a href="#docusaurus-build" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 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-build</code></h3>
|
||
<p>别名︰ <code>build</code>。</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Options</th><th>Default</th><th>Description</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>
|
||
</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>
|
||
<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>
|
||
</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>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Example</strong></p>
|
||
<pre><code class="hljs css 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>
|
||
<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>
|
||
<ul>
|
||
<li><p><code>GIT_USER</code>: 与部署提交联系的 GIT 用户。</p></li>
|
||
<li><p><code>USE_SSH</code>: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.</p>
|
||
<p><strong>Example</strong></p>
|
||
<pre><code class="hljs css bash">GIT_USER=docusaurus-bot USE_SSH=<span class="hljs-literal">true</span> yarn run publish-gh-pages
|
||
</code></pre></li>
|
||
</ul>
|
||
<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>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>
|
||
<ul>
|
||
<li><code>CIRCLE_PROJECT_USERNAME</code>: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".</li>
|
||
<li><code>CIRCLE_PROJECT_REPONAME</code>: The name of the Git repo, e.g. "Docusaurus".</li>
|
||
</ul>
|
||
<p>You can learn more about configuring automatic deployments with CircleCI in the <a href="/docs/zh-CN/publishing">Publishing guide</a>.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-rename-version"></a><a href="#docusaurus-rename-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><code>docusaurus-rename-version</code></h3>
|
||
<p>Alias: <code>rename-version</code></p>
|
||
<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>
|
||
</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>
|
||
<pre><code class="hljs css 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>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-start"></a><a href="#docusaurus-start" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 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-start</code></h3>
|
||
<p>Alias: <code>start</code>.</p>
|
||
<p>This script 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>
|
||
</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>
|
||
</tbody>
|
||
</table>
|
||
<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>version</code></p>
|
||
<p>Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.</p>
|
||
<p>See the <a href="/docs/zh-CN/versioning">Versioning guide</a> to learn more.</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>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="versioning">← Versioning</a><a class="docs-next button" href="doc-markdown">Markdown Features →</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><h5>Docs</h5><a href="
|
||
/docs/zh-CN/installation.html">Getting Started</a><a href="
|
||
/docs/zh-CN/versioning.html">Versioning</a><a href="
|
||
/docs/zh-CN/translation.html">Localization</a><a href="
|
||
/docs/zh-CN/search.html">Adding Search</a></div><div><h5>Community</h5><a href="/zh-CN/users.html">User Showcase</a></div><div><h5>More</h5><div class="social"><a class="github-button" href="https://github.com/facebook/Docusaurus" data-count-href="/facebook/Docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Docusaurus</a></div><div class="social"><a href="https://twitter.com/docusaurus" class="twitter-follow-button">Follow @docusaurus</a></div><div class="social"><div class="fb-like" data-href="https://docusaurus.io" data-layout="standard" data-share="true" data-width="225" data-show-faces="false"></div></div></div></section><a href="https://code.facebook.com/projects/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright"><span>Copyright © 2018 Facebook Inc.</span></section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>window.fbAsyncInit = function() {FB.init({appId:'199138890728411',xfbml:true,version:'v2.7'});};(function(d, s, id){var js, fjs = d.getElementsByTagName(s)[0];if (d.getElementById(id)) {return;}js = d.createElement(s); js.id = id;js.src = '//connect.facebook.net/en_US/sdk.js';fjs.parentNode.insertBefore(js, fjs);}(document, 'script','facebook-jssdk'));
|
||
</script><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script><script>
|
||
var search = docsearch({
|
||
|
||
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
|
||
indexName: 'docusaurus',
|
||
inputSelector: '#search_input_react'
|
||
});
|
||
</script></body></html> |