https://github.com/couchset/docs
CouchSet website
https://github.com/couchset/docs
Last synced: about 1 year ago
JSON representation
CouchSet website
- Host: GitHub
- URL: https://github.com/couchset/docs
- Owner: couchset
- Created: 2021-09-17T07:34:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-29T19:15:19.000Z (over 4 years ago)
- Last Synced: 2025-01-29T23:29:19.337Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://couchset.org
- Size: 1.77 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- 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
```
$ 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.