mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-31 23:54:25 +00:00
* chore(v2): allow React v17 as peer dependency * minor React 17 changes * Revert examples * Possible fix * Use @docusaurus/react-loadable fork * add back react-loadable to please eslint/ts/linters, even if it's unused in practice * missing dependency bump * move enzyme dependencies to docusaurus v1 Co-authored-by: slorber <lorber.sebastien@gmail.com> |
||
|---|---|---|
| .. | ||
| blog | ||
| docs | ||
| src/pages | ||
| static | ||
| .gitignore | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| sidebars.js | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.