mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-16 10:37:20 +02:00
150 lines
No EOL
17 KiB
HTML
150 lines
No EOL
17 KiB
HTML
<!DOCTYPE html><html lang="zh-CN"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Creating your site · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。</p>
|
||
"/><meta name="docsearch:version" content="1.0.13"/><meta name="docsearch:language" content="zh-CN"/><meta property="og:title" content="Creating your site · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="<p>Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。</p>
|
||
"/><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/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>1.0.13</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/zh-CN/1.0.13/installation" target="_self">Docs</a></li><li class=""><a href="/zh-CN/help" target="_self">Help</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">Blog</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" alt="Languages icon"/>简体中文</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/1.0.13/site-creation">English</a></li><li><a href="/docs/es-ES/1.0.13/site-creation">Español</a></li><li><a href="/docs/ro/1.0.13/site-creation">Română</a></li><li><a href="/docs/tr/1.0.13/site-creation">Türkçe</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="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>Getting Started</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Getting Started<span class="arrow">⌃</span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/site-preparation">Site Preparation</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/zh-CN/1.0.13/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/publishing">Publishing your site</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides<span class="arrow">⌃</span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/translation">Translations & Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/versioning">Versioning</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">API<span class="arrow">⌃</span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/commands">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/api-pages">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/zh-CN/1.0.13/site-config">siteConfig.js</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');
|
||
|
||
const headings = document.querySelector('.toc-headings');
|
||
headings && headings.addEventListener('click', function(event) {
|
||
if (event.target.tagName === 'A') {
|
||
document.body.classList.remove('tocActive');
|
||
}
|
||
}, 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"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/zh-CN" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Creating your site</h1></header><article><div><span><p>Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。</p>
|
||
<p>在 <a href="/docs/zh-CN/1.0.13/installation">installation</a> 和 <a href="/docs/zh-CN/1.0.13/site-preparation">preparation</a> 之后，为您的文档创建基础站点的工作大部分已完成。</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>您的网站结构如下所示：</p>
|
||
<pre><code class="hljs css language-bash">root-of-repo
|
||
├── docs
|
||
└── website
|
||
│ └── blog
|
||
│ └── core
|
||
│ └── Footer.js
|
||
│ └── node_modules
|
||
│ └── package.json
|
||
│ └── pages
|
||
│ └── sidebars.json
|
||
│ └── siteConfig.js
|
||
│ └── static
|
||
</code></pre>
|
||
<blockquote>
|
||
<p>假设你删除了由 <a href="/docs/zh-CN/1.0.13/installation">初始化</a> 脚本所创建的示例 <code>.md</code> 文件。</p>
|
||
</blockquote>
|
||
<p>All of your documentation files should be placed inside the <code>docs</code> folder as markdown <code>.md</code> files. Any blog posts should be inside the <code>blog</code> folder.</p>
|
||
<blockquote>
|
||
<p>博客的文章格式应统一为 <code>YYYY-MM-DD-your-file-name.md</code></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>创建一个功能齐备的网站，你只需要以下几步：</p>
|
||
<ol>
|
||
<li><p>Add your documentation to the <code>/docs</code> folder as <code>.md</code> files, ensuring you have the proper <a href="/docs/zh-CN/1.0.13/doc-markdown#documents">header</a> in each file. The simplest header would be the following, where <code>id</code> is the link name (e.g., <code>docs/intro.html</code>) and the <code>title</code>, is, of course, the title of the browser page.</p>
|
||
<pre><code class="hljs"> ---
|
||
id: intro
|
||
title: Getting Started
|
||
---
|
||
|
||
My *new content* here..
|
||
</code></pre></li>
|
||
<li><p>Add zero or more docs to the <a href="/docs/zh-CN/1.0.13/navigation#adding-docs-to-a-sidebar"><code>sidebars.json</code></a> file so that your documentation is rendered in a sidebar, if you choose them to be.</p>
|
||
<blockquote>
|
||
<p>If you do not add your documentation to the <code>sidebars.json</code> file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.</p>
|
||
</blockquote></li>
|
||
<li><p>Modify the <code>website/siteConfig.js</code> file to <a href="/docs/zh-CN/1.0.13/site-config">configure your site</a>, following the comments included in the <a href="/docs/zh-CN/1.0.13/site-config">docs</a> and the <code>website/siteConfig.js</code> to guide you.</p></li>
|
||
<li><p>Create any <a href="/docs/zh-CN/1.0.13/custom-pages#customizing-your-site-footer">custom pages</a> and/or <a href="/docs/zh-CN/1.0.13/custom-pages#customizing-your-site-footer">customize</a> the <code>website/core/Footer.js</code> file that provides the footer for your site.</p></li>
|
||
<li><p>Place assets, such as images, in the <code>website/static/</code> folder.</p></li>
|
||
<li><p>Run the site to see the results of your changes.</p>
|
||
<pre><code class="hljs"> cd website
|
||
yarn run start # or `npm run start`
|
||
# navigate to http://localhost:3000</code></pre></li>
|
||
</ol>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/zh-CN/1.0.13/site-preparation"><span class="arrow-prev">← </span><span>Site Preparation</span></a><a class="docs-next button" href="/docs/zh-CN/1.0.13/publishing"><span>Publishing your site</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></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/users">User Showcase</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://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 © 2019 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>
|
||
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:1.0.13"]}
|
||
});
|
||
</script></body></html> |