3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 08:49:51 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 6b2f57c29c
This commit is contained in:
Website Deployment Script 2018-06-10 19:21:05 +00:00
parent 6b2f57c29c
commit 4546c36b7d
368 changed files with 25613 additions and 1429 deletions
Download patch file Download diff file Expand all files Collapse all files

33
docs/zh-CN/custom-pages.html
View file

@ -12,7 +12,7 @@
{"zIndex":100}
)
});
</script><link rel="stylesheet" href="/css/prism.css"/><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"><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="/docs/en/custom-pages">English</a></li><li><a href="/docs/es-ES/custom-pages">Español</a></li><li><a href="/docs/ro/custom-pages">Română</a></li><li><a href="/docs/tr/custom-pages">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>
</script><link rel="stylesheet" href="/css/prism.css"/><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"><h3>1.2.0</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="/docs/en/custom-pages">English</a></li><li><a href="/docs/es-ES/custom-pages">Español</a></li><li><a href="/docs/ro/custom-pages">Română</a></li><li><a href="/docs/tr/custom-pages">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(){
@ -51,28 +51,27 @@
<p>You can <a href="/docs/zh-CN/site-preparation#verifying-installation">start</a> your local server and go to <code>http://localhost:3000</code> to see what the example home page looks like. 在那里，编辑<code>website/pages/en/index.js</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>Docusaurus provides some simple example pages in the <code>website/pages/en</code> directory, including <code>index.js</code>, <code>users.js</code>, and <code>help.js</code>. These are good examples to showcase how to create a custom page for Docusaurus.</p>
<pre><code class="hljs css languages- bash">root-of-repo
<pre><code class="hljs css languages- bash">root-directory
├── docs
├── website
│ ├── blog
│ ├── core
│ │ └── Footer.js
│ ├── node_modules
│ ├── package.json
│ ├── pages
│ │ ├── index.js
│ │ ├── users.js
│ │ └── help.js
│ ├── sidebars.json
│ ├── siteConfig.js
│ └── static
└── website
├── blog
├── core
│ └── Footer.js
├── package.json
├── pages
│ ├── index.js
│ ├── users.js
│ └── help.js
├── sidebars.json
├── siteConfig.js
└── static
</code></pre>
<p>Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 <a href="/docs/zh-CN/api-pages"> 的 </a> 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 <a href="/docs/zh-CN/navigation"> 的</a> 处找到。</p>
<blockquote>
<p>If you want your page to show up in your navigation header, you will need to update <code>siteConfig.js</code> to add to the <code>headerLinks</code> element. e.g., <code>{ page: 'about-slash', label: 'About/' }</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>Static <code>.html</code> files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the <code>static</code> folder in the same way as other <a href="/docs/zh-CN/api-pages#using-static-assets">static assets</a>. 或者，它们也可以被放置在<code>pages</code>文件夹中，并以原本方式发送给客户端，而不会被React渲染。</p>
<p>Static <code>.html</code> files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the <code>static</code> directory in the same way as other <a href="/docs/zh-CN/api-pages#using-static-assets">static assets</a>. Alternatively, they can be placed in the <code>pages</code> directory and would be served as-is instead of being rendered from React.</p>
<p>If you wish to use Docusaurus' stylesheet, you can access it at <code>${baseUrl}css/main.css</code>. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus' styles by adding them into the <code>siteConfig.separateCss</code> field in <code>siteConfig.js</code>.</p>
<blockquote>
<p>You can set the <a href="/docs/zh-CN/site-config#optional-fields"><code>$wrapPagesHTML</code> site config option</a> in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.</p>
@ -81,7 +80,7 @@
<p>Starting from the example <code>core/Footer.js</code> file that was <a href="/docs/zh-CN/site-creation">created</a> when you ran the <a href="/docs/zh-CN/installation">Docusaurus initialization script</a>, edit the footer to include any links to pages on your site or other sites that you wish to have.</p>
<p>提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！</p>
<p>一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。</p>
<p>Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.</p>
<p>Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.</p>
<p>If you do not want a footer for your site, change the <code>render</code> function of <code>core/Footer.js</code> to return <code>null</code>. e.g.,</p>
<pre><code class="hljs css languages- jsx"><span class="token keyword">const</span> React <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">'react'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>