15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 09:43:10 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(v2): Add migration info doc regarding docs folder location (#3962)

This commit is contained in:
Sébastien Lorber 2020-12-29 10:57:35 +01:00 committed by GitHub
parent 141d062c3b
commit e5610a475d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
website/docs/migration/migration-overview.md
View File

@ -33,22 +33,30 @@ Your Docusaurus 1 site should have the following structure:
## Docusaurus 2 structure
After the migration, your Docusaurus 2 site should look like:
After the migration, your Docusaurus 2 site could look like:
```sh
website
├── blog
├── docs
├── src
│ ├── components
│ ├── css
│ └── pages
├── static
├── package.json
├── sidebars.json
├── docusaurus.config.js
└── website
├── blog
├── src
│ ├── components
│ ├── css
│ └── pages
├── static
├── package.json
├── sidebars.json
├── docusaurus.config.js
```
:::info
This migration does not change the `/docs` folder location, but Docusaurus v2 sites generally have the `/docs` folder inside `/website`
You are free to put the `/docs` folder anywhere you want after having migrated to v2.
:::
## Migration process
There are multiple things to migrate to obtain a fully functional Docusaurus 2 website: