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

docs: add more info on cleanUrl siteconfig (#1847)

Browse source 
* Update api-site-config.md

Added a clarification to the cleanUrl property to set it false if the users intend to use docusaurus only offline.

* Update api-site-config.md

Added the copyright information.

* Update api-site-config.md
This commit is contained in:
Eric Ponvelle 2019-10-16 23:41:24 -04:00 • committed by Endi
parent 3086bbf995
commit 9e7e9670b3
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -106,6 +106,8 @@ Control the title of the blog sidebar. See the [adding a blog docs](guides-blog.
If `true`, allow URLs with no `HTML` extension. For example, a request to URL https://docusaurus.io/docs/installation will return the same result as https://docusaurus.io/docs/installation.html.
***Note:*** If users intend for this website to be used exclusively offline, this value must be set to 'false.' Otherwise, it will cause an offline site to route to the parent folder of the linked page.
#### `cname` [string]
The CNAME for your website. It will go into a `CNAME` file when your site is built.