Aakansha Doshi
966ca2ffa6
refactor: rename docs to dev-docs (#5487)
|
3 år sedan | |
|---|---|---|
| .. | ||
| docs | 3 år sedan | |
| src | 3 år sedan | |
| static | 3 år sedan | |
| .gitignore | 3 år sedan | |
| README.md | 3 år sedan | |
| babel.config.js | 3 år sedan | |
| docusaurus.config.js | 3 år sedan | |
| package.json | 3 år sedan | |
| sidebars.js | 3 år sedan | |
| tsconfig.json | 3 år sedan | |
| yarn.lock | 3 år sedan | |
README.md
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 opens 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
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> 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.