https://github.com/capy-ui/documentation

https://github.com/capy-ui/documentation

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/capy-ui/documentation
• Owner: capy-ui
• Created: 2022-12-20T10:43:52.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-04T17:07:59.000Z (3 months ago)
• Last Synced: 2024-08-04T19:16:13.041Z (3 months ago)
• Language: JavaScript
• Size: 327 KB
• Stars: 2
• Watchers: 1
• 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.