3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-05 04:12:53 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 226741598f
This commit is contained in:
Website Deployment Script 2017-10-26 19:16:15 +00:00
parent 226741598f
commit 09740316dd
8 changed files with 25 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/en/navigation.html
View file

@ -18,13 +18,13 @@
<h2><a class="anchor" name="adding-docs-to-a-sidebar"></a>Adding Docs to a Sidebar <a class="hash-link" href="#adding-docs-to-a-sidebar">#</a></h2>
<p>Now we want our new page to show up on the sidebar. We configure the order of the sidebar in <code>website/sidebars.json</code>.</p>
<p>Within <code>sidebars.json</code>, add the doc ID within an existing sidebar/category:</p>
<pre><code>{
<pre><code class="hljs">{
<span class="hljs-string">"docs"</span>: {
<span class="hljs-string">"Getting Started"</span>: [
<span class="hljs-string">"getting-started"</span>
</code></pre>
<p>Or you can create a new category within the sidebar:</p>
<pre><code>{
<pre><code class="hljs">{
<span class="hljs-string">"docs"</span>: {
...
<span class="hljs-string">"My New Sidebar Category"</span>: [
@ -34,7 +34,7 @@
</code></pre>
<h2><a class="anchor" name="new-hidden-sections"></a>New Hidden Sections <a class="hash-link" href="#new-hidden-sections">#</a></h2>
<p>You can also put the doc in a new sidebar. In this case we are creating a <code>intro</code> section within <code>sidebars.json</code>.</p>
<pre><code>{
<pre><code class="hljs">{
<span class="hljs-string">"intro"</span>: {
<span class="hljs-string">"My Sidebar Category"</span>: [
<span class="hljs-string">"getting-started"</span>
@ -45,7 +45,7 @@
<p>Keep in mind, until you add the section to the nav bar (below), this new &quot;intro&quot; section of the site will be hidden with no links going to it.</p>
<h2><a class="anchor" name="adding-doc-to-site-nav-bar"></a>Adding doc to site nav bar <a class="hash-link" href="#adding-doc-to-site-nav-bar">#</a></h2>
<p>After creating a new section of the site by adding to <code>sidebars.json</code>, you can link to the new doc from the top navigation bar by editing the <code>headerLinks</code> field of <code>siteConfig.js</code>.</p>
<pre><code>headerLinks: [
<pre><code class="hljs">headerLinks: [
...
{ doc: <span class="hljs-string">'intro'</span>, <span class="hljs-keyword">label</span><span class="bash">: <span class="hljs-string">'Getting Started'</span> },
</span> ...
@ -53,7 +53,7 @@
</code></pre>
<h2><a class="anchor" name="custom-page-links-in-nav-bar"></a>Custom page links in nav bar <a class="hash-link" href="#custom-page-links-in-nav-bar">#</a></h2>
<p>To add custom pages to the navigation bar, entries can be added to the <code>headerLinks</code> of <code>siteConfig.js</code>. For example, if we have a page within <code>website/pages/help.js</code>, we can link to it by adding the following:</p>
<pre><code>headerLinks: [
<pre><code class="hljs">headerLinks: [
...
{ page: <span class="hljs-string">'help'</span>, <span class="hljs-keyword">label</span><span class="bash">: <span class="hljs-string">'Help'</span> },
</span> ...
@ -61,7 +61,7 @@
</code></pre>
<h2><a class="anchor" name="external-links-in-nav-bar"></a>External links in nav bar <a class="hash-link" href="#external-links-in-nav-bar">#</a></h2>
<p>Custom links can be added to the nav bar with the following entry in <code>siteConfig.js</code>:</p>
<pre><code>headerLinks: [
<pre><code class="hljs">headerLinks: [
...
{ href: <span class="hljs-string">'https://github.com/facebookexperimental/Docusaurus'</span>, <span class="hljs-keyword">label</span><span class="bash">: <span class="hljs-string">'GitHub'</span> },
</span> ...
@ -70,7 +70,7 @@
<p>To open external links in a new tab, provide an <code>external: true</code> flag within the header link config.</p>
<h2><a class="anchor" name="search-bar-position-in-nav-bar"></a>Search bar position in nav bar <a class="hash-link" href="#search-bar-position-in-nav-bar">#</a></h2>
<p>If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the <code>headerLinks</code> config array:</p>
<pre><code><span class="hljs-string">headerLinks:</span> [
<pre><code class="hljs"><span class="hljs-string">headerLinks:</span> [
{ <span class="hljs-string">doc:</span> <span class="hljs-string">'foo'</span>, <span class="hljs-string">label:</span> <span class="hljs-string">'Foo'</span> },
{ <span class="hljs-string">search:</span> <span class="hljs-literal">true</span> },
{ <span class="hljs-string">doc:</span> <span class="hljs-string">'bar'</span>, <span class="hljs-string">label:</span> <span class="hljs-string">'Bar'</span> },
@ -78,7 +78,7 @@
</code></pre>
<h2><a class="anchor" name="languages-dropdown-position-in-nav-bar"></a>Languages dropdown position in nav bar <a class="hash-link" href="#languages-dropdown-position-in-nav-bar">#</a></h2>
<p>If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the <code>headerLinks</code> config array:</p>
<pre><code><span class="hljs-string">headerLinks:</span> [
<pre><code class="hljs"><span class="hljs-string">headerLinks:</span> [
{ <span class="hljs-string">doc:</span> <span class="hljs-string">'foo'</span>, <span class="hljs-string">label:</span> <span class="hljs-string">'Foo'</span> },
{ <span class="hljs-string">languages:</span> <span class="hljs-literal">true</span> },
{ <span class="hljs-string">doc:</span> <span class="hljs-string">'bar'</span>, <span class="hljs-string">label:</span> <span class="hljs-string">'Bar'</span> },