2020-09-18 16:31:22 -04:00
|
|
|
<!--
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
|
|
or more contributor license agreements. See the NOTICE file
|
|
|
|
distributed with this work for additional information
|
|
|
|
regarding copyright ownership. The ASF licenses this file
|
|
|
|
to you under the Apache License, Version 2.0 (the
|
|
|
|
"License"); you may not use this file except in compliance
|
|
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
|
|
software distributed under the License is distributed on an
|
|
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
|
KIND, either express or implied. See the License for the
|
|
|
|
specific language governing permissions and limitations
|
|
|
|
under the License.
|
|
|
|
-->
|
2020-09-12 01:59:12 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
# Website
|
2020-09-12 01:59:12 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
2020-09-12 01:59:12 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
### Installation
|
2020-09-12 01:59:12 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
```
|
|
|
|
$ yarn
|
2020-09-12 01:59:12 -04:00
|
|
|
```
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
### Local Development
|
2021-04-23 12:43:58 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
```
|
|
|
|
$ yarn start
|
|
|
|
```
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
### Build
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
```
|
|
|
|
$ yarn build
|
|
|
|
```
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
2020-09-14 14:58:45 -04:00
|
|
|
|
2022-02-02 16:02:51 -05:00
|
|
|
### Deployment
|
2020-09-14 14:58:45 -04:00
|
|
|
|
|
|
|
```
|
2022-02-02 16:02:51 -05:00
|
|
|
$ 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.
|