https://github.com/react-gx/gx-doc
Documentation of the gx Library.
https://github.com/react-gx/gx-doc
Last synced: about 1 year ago
JSON representation
Documentation of the gx Library.
- Host: GitHub
- URL: https://github.com/react-gx/gx-doc
- Owner: react-gx
- Created: 2023-02-26T21:14:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-13T15:57:26.000Z (over 2 years ago)
- Last Synced: 2025-05-03T06:12:37.495Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://gx-chi.vercel.app
- Size: 3.1 MB
- Stars: 2
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), 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= 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.