semaphore/apps/docs

Semaphore Docs

The official documentation of Semaphore.

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues   |   🗣️ Chat & Support

This repository contains the code for the Semaphore documentation published at docs.semaphore.pse.dev. It uses Markdown syntax and the Docusaurus site generator.

📜 Usage

Start the website

To generate the HTML and start the site, run:

yarn start

Visit the Semaphore docs site in your browser at 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=<Your GitHub username> 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.