Semaphore docs
Semaphore documentation website.
Our [documentation website](https://akinovak.github.io/semaphore-spec) was generated with [Docusaurus](https://docusaurus.io/). Please, check https://docusaurus.io/docs for more information.
---
## 🛠Install
Clone this repository and install the dependencies:
```bash
$ git clone https://github.com/akinovak/semaphore-spec.git semaphore-spec
$ cd semaphore-spec && yarn
```
## 📜 Usage
### 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.
**Notice**: You can find all the markdown documentation files in the `docs` folder.