docusaurus.config.js
Overview
docusaurus.config.js
contains configurations for your site and is placed in the root directory of your site.
Required fields
title
- Type:
string
Title for your website.
favicon
- Type:
string
URL for site favicon. Example:
You can also use the favicon URL relative to the static
directory of your site. For example, your site has the following directory structure:
So you can refer it like below:
url
- Type:
string
URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io
is the URL of https://facebook.github.io/metro/, and https://docusaurus.io
is the URL for https://docusaurus.io. This field is related to the baseUrl field.
baseUrl
- Type:
string
Base URL for your site. This can also be considered the path after the host. For example, /metro/
is the baseUrl of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to /
. This field is related to the url field.
Optional fields
tagline
- Type:
string
The tagline for your website.
organizationName
- Type:
string
The GitHub user or organization that owns the repository. Used by the deployment command.
projectName
- Type:
string
The name of the GitHub repository. Used by the deployment command.
githubHost
- Type:
string
The hostname of your server. Useful if you are using GitHub Enterprise.
themeConfig
- Type:
Object
An object containing data needed by the theme you use.
For Docusaurus' default theme classic, we use themeConfig
to customize your navbar and footer links:
Example:
plugins
- Type:
any[]
themes
- Type:
any[]
presets
- Type:
any[]
customFields
Docusaurus guards docusaurus.config.js
from unknown fields. To add a custom field, define it on customFields
- Type:
Object
Attempting to add unknown field in the config will lead to error in build time:
scripts
An array of scripts to load. The values can be either strings or plain objects of attribute-value maps. The <script>
tags will be inserted in the HTML <head>
.
Note that <script>
added here are render-blocking so you might want to add async: true
/defer: true
to the objects.
- Type:
(string | Object)[]
Example:
stylesheets
An array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The <link>
tags will be inserted in the HTML <head>
.
- Type:
(string | Object)[]
Example: