From baa1eaa425cf5e95be6166bcf3e60d320e3cfa16 Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Tue, 6 Feb 2018 16:05:01 +0000 Subject: [PATCH] Deploy website Deploy website version based on fe95612b5d2dc7fb7119f3e63138dee532b6c696 --- docs/en/site-config.html | 54 ++++++++++++++++++++++++------------------------ 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/en/site-config.html b/docs/en/site-config.html index 2b50567025..49f441eff0 100644 --- a/docs/en/site-config.html +++ b/docs/en/site-config.html @@ -11,12 +11,16 @@

siteConfig Fields

The siteConfig object contains the bulk of the configuration settings for your website.

Mandatory Fields

-

title - Title for your website.

-

tagline - Tagline for your website.

-

url - url for your site.

baseUrl - baseUrl for your site.

-

projectName - Project name. This must match your GitHub repo project name (case sensitive).

-

noIndex - Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.

+

colors - Color configurations for the site.

+ +

copyright - The copyright string at footer of site and within feed

+

favicon - url for site favicon.

+

headerIcon - url for icon used in header navigation bar.

headerLinks - Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.

Example Usage:

headerLinks: [
@@ -34,21 +38,23 @@
   { languages: true }
 ],
-

headerIcon - url for icon used in header navigation bar.

-

favicon - url for site favicon.

-

colors - Color configurations for the site.

- -

copyright - The copyright string at footer of site and within feed

+

noIndex - Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

tagline - Tagline for your website.

+

title - Title for your website.

+

url - url for your site.

Optional Fields

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.

+

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

customDocsPath - By default, Docusaurus expects your documentation to be in a directory called docs. This directory is at the same level as the website directory (i.e., not inside the website directory). You can specify a custom path to your documentation with this field. *Note that all of your documentation .md files must still reside in a flat hierarchy. You cannot have your documents in nested directories.

customDocsPath: "docs/site"
 
customDocsPath: "website-docs"
+

disableHeaderTitle - 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 true.

+

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

+

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

+

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts 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.

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

fonts: {
@@ -67,19 +73,8 @@
   font-family: $myFont;
 }
-

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

-

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

-

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

-

users - The users array mentioned earlier.

-

disableHeaderTitle - 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 true.

-

disableTitleTagline - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline. Set to true to make page titles just Title.

-

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus's styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

footerIcon - url for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

-

translationRecruitingLink - url for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

-

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.

gaTrackingId - Google Analytics tracking ID to track page views.

-

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

-

twitter - set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

highlight - Syntax highlighting options:

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

-

wrapPagesHTML - boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus's styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

-

cname - The CNAME for your website. It will go into a CNAME file when your site it built.

+

translationRecruitingLink - url for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

+

twitter - set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

Users can also add their own custom fields if they wish to provide some data across different files.

Example siteConfig.js with all fields

const users = [