1*2167191dSAndroid Build Coastguard Worker# Website 2*2167191dSAndroid Build Coastguard Worker 3*2167191dSAndroid Build Coastguard WorkerThis website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. 4*2167191dSAndroid Build Coastguard Worker 5*2167191dSAndroid Build Coastguard WorkerThe instructions bellow assume that you're inside `docs/` directory. 6*2167191dSAndroid Build Coastguard Worker 7*2167191dSAndroid Build Coastguard Worker### Installation 8*2167191dSAndroid Build Coastguard Worker 9*2167191dSAndroid Build Coastguard Worker``` 10*2167191dSAndroid Build Coastguard Worker$ npm install 11*2167191dSAndroid Build Coastguard Worker``` 12*2167191dSAndroid Build Coastguard Worker 13*2167191dSAndroid Build Coastguard Worker### Local Development 14*2167191dSAndroid Build Coastguard Worker 15*2167191dSAndroid Build Coastguard Worker``` 16*2167191dSAndroid Build Coastguard Worker$ npm start 17*2167191dSAndroid Build Coastguard Worker``` 18*2167191dSAndroid Build Coastguard Worker 19*2167191dSAndroid Build Coastguard WorkerThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. 20*2167191dSAndroid Build Coastguard Worker 21*2167191dSAndroid Build Coastguard Worker### Build 22*2167191dSAndroid Build Coastguard Worker 23*2167191dSAndroid Build Coastguard Worker``` 24*2167191dSAndroid Build Coastguard Worker$ npm run build 25*2167191dSAndroid Build Coastguard Worker``` 26*2167191dSAndroid Build Coastguard Worker 27*2167191dSAndroid Build Coastguard WorkerThis command generates static content into the `build` directory and can be served using any static contents hosting service. 28*2167191dSAndroid Build Coastguard Worker 29*2167191dSAndroid Build Coastguard Worker### Deployment 30*2167191dSAndroid Build Coastguard Worker 31*2167191dSAndroid Build Coastguard WorkerThe site is built and published to GitHub Pages via GitHub Actions. 32*2167191dSAndroid Build Coastguard Worker 33*2167191dSAndroid Build Coastguard Worker### Manual Deployment 34*2167191dSAndroid Build Coastguard Worker 35*2167191dSAndroid Build Coastguard WorkerUsing SSH: 36*2167191dSAndroid Build Coastguard Worker 37*2167191dSAndroid Build Coastguard Worker``` 38*2167191dSAndroid Build Coastguard Worker$ USE_SSH=true yarn deploy 39*2167191dSAndroid Build Coastguard Worker``` 40*2167191dSAndroid Build Coastguard Worker 41*2167191dSAndroid Build Coastguard WorkerNot using SSH: 42*2167191dSAndroid Build Coastguard Worker 43*2167191dSAndroid Build Coastguard Worker``` 44*2167191dSAndroid Build Coastguard Worker$ GIT_USER=<Your GitHub username> yarn deploy 45*2167191dSAndroid Build Coastguard Worker``` 46*2167191dSAndroid Build Coastguard Worker 47*2167191dSAndroid Build Coastguard WorkerIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. 48