https://github.com/capy-ui/documentation
https://github.com/capy-ui/documentation
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/capy-ui/documentation
- Owner: capy-ui
- Created: 2022-12-20T10:43:52.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T22:26:19.000Z (7 months ago)
- Last Synced: 2025-03-14T23:51:15.618Z (about 2 months ago)
- Language: JavaScript
- Size: 332 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
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.