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

Deploy website

Browse source 
Deploy website version based on 8cd4b4fca6
This commit is contained in:
Website Deployment Script 2018-07-09 03:22:29 +00:00
parent daf63274f7
commit 5d4d0d0423
2334 changed files with 12240 additions and 12240 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/en/next/site-config.html
View file

@ -66,7 +66,7 @@
<p><code>headerIcon</code> - URL for icon used in header navigation bar.</p>
<p><code>headerLinks</code> - Links that will be used in the header navigation bar. The <code>label</code> field of each object will be the link text and will also be translated for each language.</p>
<p>Example Usage:</p>
<pre><code class="hljs css languages- js">headerLinks: [
<pre><code class="hljs css languages-js">headerLinks: [
<span class="hljs-comment">// Links to document with id doc1 for current language/version</span>
{ <span class="hljs-attr">doc</span>: <span class="hljs-string">"doc1"</span>, <span class="hljs-attr">label</span>: <span class="hljs-string">"Getting Started"</span> },
<span class="hljs-comment">// Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language</span>
@ -99,9 +99,9 @@
<p><code>cleanUrl</code> - If <code>true</code>, allow URLs with no <code>html</code> extension. For example, a request to URL <a href="https://docusaurus.io/docs/installation">https://docusaurus.io/docs/installation</a> will returns the same result as <a href="https://docusaurus.io/docs/installation.html">https://docusaurus.io/docs/installation.html</a>.</p>
<p><code>cname</code> - The CNAME for your website. It will go into a <code>CNAME</code> file when your site is built.</p>
<p><code>customDocsPath</code> - By default, Docusaurus expects your documentation to be in a directory called <code>docs</code>. This directory is at the same level as the <code>website</code> directory (i.e., not inside the <code>website</code> directory). You can specify a custom path to your documentation with this field.</p>
<pre><code class="hljs css languages- js">customDocsPath: <span class="hljs-string">'docs/site'</span>;
<pre><code class="hljs css languages-js">customDocsPath: <span class="hljs-string">'docs/site'</span>;
</code></pre>
<pre><code class="hljs css languages- js">customDocsPath: <span class="hljs-string">'website-docs'</span>;
<pre><code class="hljs css languages-js">customDocsPath: <span class="hljs-string">'website-docs'</span>;
</code></pre>
<p><code>defaultVersionShown</code> - The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
<p><code>disableHeaderTitle</code> - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to <code>true</code>.</p>
@ -112,7 +112,7 @@
<p><code>facebookPixelId</code> - <a href="https://www.facebook.com/business/a/facebook-pixel">Facebook Pixel</a> ID to track page views.</p>
<p><code>fonts</code> - Font-family CSS configuration for the site. If a font family is specified in <code>siteConfig.js</code> as <code>$myFont</code>, then adding a <code>myFont</code> key to an array in <code>fonts</code> will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.</p>
<p>In the below example, we have two sets of font configurations, <code>myFont</code> and <code>myOtherFont</code>. <code>Times New Roman</code> is the preferred font in <code>myFont</code>. <code>-apple-system</code> is the preferred in <code>myOtherFont</code>.</p>
<pre><code class="hljs css languages- js">fonts: {
<pre><code class="hljs css languages-js">fonts: {
<span class="hljs-attr">myFont</span>: [
<span class="hljs-string">'Times New Roman'</span>,
<span class="hljs-string">'Serif'</span>
@ -124,7 +124,7 @@
},
</code></pre>
<p>The above fonts would be represented in your CSS file(s) as variables <code>$myFont</code> and <code>$myOtherFont</code>.</p>
<pre><code class="hljs css languages- css"><span class="hljs-selector-tag">h1</span> {
<pre><code class="hljs css languages-css"><span class="hljs-selector-tag">h1</span> {
<span class="hljs-attribute">font-family</span>: $myFont;
}
</code></pre>
@ -161,7 +161,7 @@
<p><code>wrapPagesHTML</code> - Boolean flag to indicate whether <code>html</code> files in <code>/pages</code> should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being <code>html</code> fragments instead of complete pages. It inserts the contents of your <code>html</code> file with no extra processing. Defaults to <code>false</code>.</p>
<p>Users can also add their own custom fields if they wish to provide some data across different files.</p>
<h2><a class="anchor" aria-hidden="true" id="example-siteconfigjs-with-many-available-fields"></a><a href="#example-siteconfigjs-with-many-available-fields" 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>Example siteConfig.js with many available fields</h2>
<pre><code class="hljs css languages- js"><span class="hljs-keyword">const</span> users = [
<pre><code class="hljs css languages-js"><span class="hljs-keyword">const</span> users = [
{
<span class="hljs-attr">caption</span>: <span class="hljs-string">'User1'</span>,
<span class="hljs-attr">image</span>: <span class="hljs-string">'/test-site/img/docusaurus.svg'</span>,