siteConfig.js
A large part of site configuration is done by editing the siteConfig.js file.
User Showcase #
The users array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someon. The pinned field determines whether or not it shows up on the index page.
Currently this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.
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).
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: [ +
siteConfig.js
A large part of site configuration is done by editing the siteConfig.js file.
User Showcase #
The users array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someon. The pinned field determines whether or not it shows up on the index page.
Currently this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.
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.
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: [ // Links to document with id doc1 for current language/version { doc: "doc1", label: "Getting Started" }, // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language @@ -34,6 +34,7 @@ baseUrl: "/test-site/", // baseUrl: "/", projectName: "docusaurus", + noIndex: false, headerLinks: [ { doc: "doc1", label: "Docs" }, { page: "help", label: "Help" },