https://github.com/keajs/kea-docs
https://github.com/keajs/kea-docs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/keajs/kea-docs
- Owner: keajs
- Created: 2020-04-10T10:15:38.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T09:06:45.000Z (6 months ago)
- Last Synced: 2024-12-10T10:19:31.334Z (6 months ago)
- Language: TypeScript
- Homepage: https://kea.js.org/
- Size: 13.5 MB
- Stars: 3
- Watchers: 3
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and open 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
```
$ GIT_USER= 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.