docs: mention about website directory naming (#1106)

docs: mention about website directory naming
This commit is contained in:
Alexandre ZANNI 2018-11-12 00:14:39 +01:00 committed by Yangshun Tay
parent b84754dde8
commit 2bf2dfe173

View file

@ -54,11 +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.
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.
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`.