From 9e7e9670b3b0e43f198bebac48a9aab5d2c3cd1a Mon Sep 17 00:00:00 2001 From: Eric Ponvelle Date: Wed, 16 Oct 2019 23:41:24 -0400 Subject: [PATCH] docs: add more info on cleanUrl siteconfig (#1847) * 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 --- docs/api-site-config.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-site-config.md b/docs/api-site-config.md index fa9efd9a57..e3017dabd0 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -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.