From 8e34c692be100de1ff451accb2f0f808996bc5f9 Mon Sep 17 00:00:00 2001 From: Alexandre ZANNI <16578570+noraj@users.noreply.github.com> Date: Sun, 11 Nov 2018 23:45:34 +0100 Subject: [PATCH 1/3] ability to rename the website folder fixing #1082 --- docs/getting-started-preparation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getting-started-preparation.md b/docs/getting-started-preparation.md index b472e1e58cad..4ee62569eadd 100644 --- a/docs/getting-started-preparation.md +++ b/docs/getting-started-preparation.md @@ -57,6 +57,9 @@ root-directory You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. The value of the `customDocsPath` key in `website/siteConfig.js` can be modified if you wish to use a different directory name or path. +Also the folder `website` can be renamed as you want without the need to modify the configuration file, +for example if `website` is a source of conflict with another folder of your project you are able to rename it +into `docusaurus`. You should keep the `website/pages` and `website/static` directories, but may change the content inside them as you wish. At the bare minimum you should have From b136760eab416e06c4464a30b9b02a690cbec9ed Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sun, 11 Nov 2018 15:13:26 -0800 Subject: [PATCH 2/3] Update getting-started-preparation.md --- docs/getting-started-preparation.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/docs/getting-started-preparation.md b/docs/getting-started-preparation.md index 4ee62569eadd..03b8c78b64ba 100644 --- a/docs/getting-started-preparation.md +++ b/docs/getting-started-preparation.md @@ -54,14 +54,7 @@ root-directory ## Preparation Notes -You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` -files, but may edit them as you wish. The value of the `customDocsPath` key in -`website/siteConfig.js` can be modified if you wish to use a different directory name or path. -Also the folder `website` can be renamed as you want without the need to modify the configuration file, -for example if `website` is a source of conflict with another folder of your project you are able to rename it -into `docusaurus`. +You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. The value of the `customDocsPath` key in `website/siteConfig.js` can be modified if you wish to use a different directory name or path. +The `website` directory can also be renamed to anything you want it to. -You should keep the `website/pages` and `website/static` directories, but may -change the content inside them as you wish. At the bare minimum you should have -an `en/index.js` or `en/index.html` file inside `website/pages` and an image to -use as your header icon inside `website/static`. +However, you should keep the `website/pages` and `website/static` directories. You may change the content inside them as you wish. At the bare minimum you should have an `en/index.js` or `en/index.html` file inside `website/pages` and an image to use as your header icon inside `website/static`. From 433cc6ce5ba3b1c3d908e083128b402585f525f3 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Sun, 11 Nov 2018 15:14:02 -0800 Subject: [PATCH 3/3] Update getting-started-preparation.md --- docs/getting-started-preparation.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/getting-started-preparation.md b/docs/getting-started-preparation.md index 03b8c78b64ba..7612a377959d 100644 --- a/docs/getting-started-preparation.md +++ b/docs/getting-started-preparation.md @@ -54,7 +54,6 @@ root-directory ## Preparation Notes -You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. The value of the `customDocsPath` key in `website/siteConfig.js` can be modified if you wish to use a different directory name or path. -The `website` directory can also be renamed to anything you want it to. +You will need to keep the `website/siteConfig.js` and `website/core/Footer.js` files, but may edit them as you wish. The value of the `customDocsPath` key in `website/siteConfig.js` can be modified if you wish to use a different directory name or path. The `website` directory can also be renamed to anything you want it to be. However, you should keep the `website/pages` and `website/static` directories. You may change the content inside them as you wish. At the bare minimum you should have an `en/index.js` or `en/index.html` file inside `website/pages` and an image to use as your header icon inside `website/static`.