You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
docs.cwtch.im/README.md

1.2 KiB

Cwtch Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

or

install NVM to manage multiple and new NodeJS versions, and then install NodeJS 16

$ nvm install 16
$ nvm use 16

nvm only works in bash shell

Local Development

$ yarn start

or

$ npm run 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

or

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment to Stable

Using git.openprivacy.ca to manage but deployment by push is to a separate docs server. Add your key to the docusaurus account's .ssh/authorized_keys and then

$ git remote add docs docusaurus@docs.cwtch.im:/home/docusaurus/git/docs.cwtch.im
$ git push docs staging

Deployment to Prod

The staging website must be manually promoted to prod. This can be done by logging into the docs server as docusarus and running:

rsync -a --delete staging/ prod/