github.com/wawandco/oxpecker@v1.5.7-0.20210910201653-5958d4afdd89/docs/web/README.md (about)

     1  # Website
     2  
     3  This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
     4  
     5  ### Installation
     6  
     7  ```
     8  $ yarn
     9  ```
    10  
    11  ### Local Development
    12  
    13  ```
    14  $ yarn start
    15  ```
    16  
    17  This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
    18  
    19  ### Build
    20  
    21  ```
    22  $ yarn build
    23  ```
    24  
    25  This command generates static content into the `build` directory and can be served using any static contents hosting service.
    26  
    27  ### Deployment
    28  
    29  ```
    30  $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
    31  ```
    32  
    33  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.