Skip to content

PocketRelay/Website

Repository files navigation

Pocket Relay Website

This is the documentation and homepage website for the Pocket Relay project. This is deployed to https://pocket-relay.pages.dev/ you can find the legacy version of this website at https://legacy.pocket-relay.pages.dev/

This website is built using Docusaurus 3, 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=<Your GitHub username> 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.