diff --git a/docs/en/site-config.html b/docs/en/site-config.html index 2850e40295..8bbea49c0c 100644 --- a/docs/en/site-config.html +++ b/docs/en/site-config.html @@ -44,12 +44,29 @@

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

Optional Fields

-

fonts - Font-family css configuration for the site. If a font family specified 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 these should be more specific. -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 - 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"
 
+

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: {
+  myFont: [
+    "Times New Roman",
+    "Serif"
+  ],
+  myOtherFont: [
+    "-apple-system",
+    "system-ui"
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  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.