Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mention about website directory naming #1106

Merged
merged 3 commits into from
Nov 11, 2018
Merged

docs: mention about website directory naming #1106

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e34c69
ability to rename the website folder
noraj Nov 11, 2018
b136760
Update getting-started-preparation.md
yangshun Nov 11, 2018
433cc6c
Update getting-started-preparation.md
yangshun Nov 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/getting-started-preparation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.