3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 18:27:56 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: mention about moving docs directory into website (#2103)

Browse source
This commit is contained in:
Yangshun Tay 2019-12-08 20:35:22 -08:00 • committed by GitHub
parent 55e676cb25
commit 2fcb81596b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/getting-started-publishing.md
View file

@ -50,6 +50,8 @@ now
**That's all.** Your docs will automatically be deployed. **That's all.** Your docs will automatically be deployed.
> Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The `docs` directory has to be within the `website` directory, ideally following the directory structure in this example. You will also have to specify a `customDocsPath` value in `siteConfig.js`. Take a look at the the [now-examples repository for a Docusaurus project](https://github.com/zeit/now-examples/tree/master/docusaurus).
### Using GitHub Pages ### Using GitHub Pages
Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/). Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/).

2
website/docs/migrating-from-v1-to-v2.md
View file

@ -153,6 +153,8 @@ module.exports = {
}; };
``` ```
We recommend moving the `docs` folder into the `website` folder and that is also the default directory structure in v2. [Now](https://zeit.co/now) supports [Docusaurus project deployments out-of-the-box](https://github.com/zeit/now-examples/tree/master/docusaurus) if the `docs` directory is within the `website`. It is also generally better for the docs to be within the website so that the docs and the rest of the website code are co-located within one `website` directory.
Refer to migration guide below for each field in `siteConfig.js`. Refer to migration guide below for each field in `siteConfig.js`.
### Updated fields ### Updated fields