Skip to content
This repository has been archived by the owner on Jan 2, 2024. It is now read-only.

Latest commit

 

History

History
97 lines (77 loc) · 3.79 KB

README.md

File metadata and controls

97 lines (77 loc) · 3.79 KB

Important

The new Semaphore website was moved to the main monorepo and split into two parts: docs and website (inside the apps folder).

Semaphore icon. Semaphore website

Github license GitHub Workflow test Code style prettier Repository top language

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

🛠 Install

Clone this repository:

git clone https://github.com/semaphore-protocol/website.git

And install the dependencies:

cd website && yarn

📜 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.