Semaphore Docs
The official documentation of Semaphore.
| This repository contains the code for the Semaphore documentation published at [docs.semaphore.pse.dev](https://docs.semaphore.pse.dev). It uses Markdown syntax and the [Docusaurus](https://docusaurus.io/) site generator. |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
## 📜 Usage
### Start the website
To generate the HTML and start the site, run:
```sh
yarn start
```
Visit the Semaphore docs site in your browser at [http://localhost:3000](http://localhost:3000).
### Build
```
yarn build
```
The `build` command generates static content into the `build` directory that can be served by any static content hosting service.
### Deploy
```
$ GIT_USER= USE_SSH=true yarn deploy
```
If you use GitHub pages for hosting, this command lets you build the website and push to the `gh-pages` branch.