docusaurus/docs/zh-CN/next/tutorial-setup.html
Website Deployment Script 245ec98007 Deploy website
Deploy website version based on 827de9a840
2021-01-10 06:32:52 +00:00

166 lines
No EOL
21 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Setting Up · Docusaurus</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="本教程是针对首次使用者的详细地说明如何从零开始完成一个的Docusaurus网站。 让我们开始吧!"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Setting Up · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="本教程是针对首次使用者的详细地说明如何从零开始完成一个的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)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44373548-31', 'auto');
ga('send', 'pageview');
</script><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><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible 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"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/zh-CN/next/installation" target="_self">文档</a></li><li class="siteNavGroupActive siteNavItemActive"><a href="/docs/zh-CN/next/tutorial-setup" target="_self">教程</a></li><li class=""><a href="/zh-CN/users" target="_self">用户</a></li><li class=""><a href="/blog/" target="_self">博客</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_blank">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>简体中文</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/next/tutorial-setup">English</a></li><li><a href="/docs/fr/next/tutorial-setup">Français</a></li><li><a href="/docs/ko/next/tutorial-setup">한국어</a></li><li><a href="/docs/pt-BR/next/tutorial-setup">Português (Brasil)</a></li><li><a href="/docs/ro/next/tutorial-setup">Română</a></li><li><a href="/docs/ru/next/tutorial-setup">Русский</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">帮助我们翻译</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
event.preventDefault();
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="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i></i><span>教程</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">教程<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem navListItemActive"><a class="navItem" href="/docs/zh-CN/next/tutorial-setup">Setting Up</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/next/tutorial-create-new-site">新建站点</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/next/tutorial-create-pages">新建页面</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/next/tutorial-publish-site">发布站点</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/next/tutorial-version">Add Versions</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</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">Setting Up</h1></header><article><div><span><p>本教程是针对首次使用者的详细地说明如何从零开始完成一个的Docusaurus网站。 让我们开始吧!</p>
<p><img src="/img/undraw_docusaurus_mountain.svg" alt="Docusaurus campfire"> {.docImage}</p>
<h2><a class="anchor" aria-hidden="true" id="安装-git"></a><a href="#安装-git" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Git</h2>
<p>Git 是一个版本控制系统,用于在软件开发过程中跟踪源代码的更改,它可以帮助您在本地系统和您的在线存储库之间同步和版本文件。 Windows 的Git包括 Git Bash(终端应用程序)。 如果尚未安装,请参阅<a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">安装 Git</a></p>
<h2><a class="anchor" aria-hidden="true" id="安装-nodejs"></a><a href="#安装-nodejs" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Node.js</h2>
<p>Node.js是一个可以在网页浏览器之外运行JavaScript代码的运行环境并被用于编写和运行服务器端JavaScript应用程序。 Node.js安装包含 <code>npm</code>(软件包管理器允许您从终端安装NPM 模块)。</p>
<ol>
<li>在 Mac、Linux 或 Unix 系统上打开终端。 在 Windows 系统上打开 Git Bash</li>
<li>如果您在 系统 上有 <code>brew</code> ,请运行以下命令来安装节点。</li>
</ol>
<pre><code class="hljs css language-sh">brew install node
</code></pre>
<p>或者,你可以从 <a href="https://nodejs.org/en/">Node.js</a> 的官网下载安装。</p>
<h2><a class="anchor" aria-hidden="true" id="检查你的-nodejs-安装情况"></a><a href="#检查你的-nodejs-安装情况" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>检查你的 Node.js 安装情况</h2>
<p>检查您是否已安装了最低要求版本:</p>
<pre><code class="hljs css language-sh">node -v
</code></pre>
<p>你应该看到一个大于 Node 8 的版本。</p>
<pre><code class="hljs css language-sh">node -v
v8.15.1
</code></pre>
<blockquote>
<p>Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="安装-yarn可选"></a><a href="#安装-yarn可选" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>安装 Yarn可选</h2>
<p>We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. 点击 <a href="https://yarnpkg.com/en/docs/install">这里查看</a></p>
<blockquote>
<p>You can still proceed with the tutorial without Yarn.</p>
</blockquote>
<h2><a class="anchor" aria-hidden="true" id="create-a-github-repository-and-local-clone"></a><a href="#create-a-github-repository-and-local-clone" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Create a GitHub repository and local clone</h2>
<ol>
<li>Go to <a href="https://github.com/">https://github.com/</a> and sign up for an account if you don't already have one.</li>
<li>Click on the green <strong>New</strong> button or go to <a href="https://github.com/new">https://github.com/new</a>.</li>
<li>Type a repository name without spaces. For example, <code>docusaurus-tutorial</code>.</li>
<li>Click <strong>Create repository</strong> (without <code>.gitignore</code> and without a license).</li>
</ol>
<p><img src="/img/tutorial-git-clone.png" alt="在Github 中创建仓库"> {.docImage}</p>
<ol start="5">
<li>在 Terminal 或 Git Bash, <code>cd</code> 到一个目录, 代码将会克隆到该目录的子目录。</li>
</ol>
<pre><code class="hljs css language-sh"><span class="hljs-built_in">cd</span> /Users/NAME/doc_projects <span class="hljs-comment"># macOS example</span>
<span class="hljs-comment"># or</span>
<span class="hljs-built_in">cd</span> /c/NAME/doc_projects <span class="hljs-comment"># Windows example</span>
</code></pre>
<ol start="6">
<li>将你的仓库克隆到你的电脑上。</li>
</ol>
<pre><code class="hljs css language-sh">git <span class="hljs-built_in">clone</span> git@github.com:USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># SSH</span>
<span class="hljs-comment"># or</span>
git <span class="hljs-built_in">clone</span> https://github.com/USERNAME/docusaurus-tutorial.git <span class="hljs-comment"># HTTPS</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="安装-docusaurus-init-初始化命令"></a><a href="#安装-docusaurus-init-初始化命令" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 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 init 初始化命令</h2>
<p>Docusaurus 带有命令行工具来帮助您手写一个 Docusaurus 网站与一些示例模板。 让我们一起来安装吧!</p>
<p>运行以下命令:</p>
<pre><code class="hljs css language-sh">npm install --global docusaurus-init
</code></pre>
<p>或者你使用的 Yarn</p>
<pre><code class="hljs css language-sh">yarn global add docusaurus-init
</code></pre>
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/zh-CN/next/tutorial-create-new-site"><span>新建站点</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#安装-git">安装 Git</a></li><li><a href="#安装-nodejs">安装 Node.js</a></li><li><a href="#检查你的-nodejs-安装情况">检查你的 Node.js 安装情况</a></li><li><a href="#安装-yarn可选">安装 Yarn可选</a></li><li><a href="#create-a-github-repository-and-local-clone">Create a GitHub repository and local clone</a></li><li><a href="#安装-docusaurus-init-初始化命令">安装 Docusaurus init 初始化命令</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="
/docs/zh-CN/search">Adding Search</a></div><div class="footerSection"><h5>Community</h5><a href="/zh-CN/help">Help</a><a href="/zh-CN/users">User Showcase</a><a href="/zh-CN/about-slash">About</a></div><div class="footerSection"><h5>Legal</h5><a href="https://opensource.facebook.com/legal/privacy/" target="_blank" rel="noreferrer noopener">Privacy</a><a href="https://opensource.facebook.com/legal/terms/" target="_blank" rel="noreferrer noopener">Terms</a><a href="https://opensource.facebook.com/legal/data-policy/" target="_blank" rel="noreferrer noopener">Data Policy</a><a href="https://opensource.facebook.com/legal/cookie-policy/" target="_blank" rel="noreferrer noopener">Cookie Policy</a></div><div class="footerSection"><h5>Social</h5><div class="social"><a class="github-button" href="https://github.com/facebook/docusaurus" data-count-href="https://github.com/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-colorscheme="dark" data-layout="standard" data-share="true" data-width="225" data-show-faces="false"></div></div></div></section><a href="https://opensource.facebook.com/" 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 © 2021 Facebook Inc.</span> Landing images by <a href="https://undraw.co/">unDraw</a>.</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>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react',
algoliaOptions: {"facetFilters":["language:zh-CN","version:next"]}
});
</script></body></html>