3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-30 15:00:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update docs for url and baseurl

Browse source 
For more clarity and to make relationship more clear
This commit is contained in:
Joel Marcey 2018-10-17 10:20:35 -07:00 • committed by GitHub
parent ba96992225
commit a39d2b0280
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api-site-config.md
View file

@ -18,7 +18,7 @@ The `siteConfig` object contains the bulk of the configuration settings for your
### Mandatory Fields
#### `baseUrl` [string]
baseUrl for your site. For example, `/pages/org/project/` is the baseUrl of https://git.facebook.com/pages/org/project/
baseUrl 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](#url-string).
#### `colors` [object]
Color configurations for the site.
@ -74,7 +74,7 @@ Tagline for your website.
Title for your website.
#### `url` [string]
URL for your website.
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-string).
### Optional Fields