|
3 weeks ago | |
---|---|---|
blog | 3 weeks ago | |
build-staging | 3 weeks ago | |
developing | 5 months ago | |
docs | 3 weeks ago | |
i18n | 3 weeks ago | |
security | 7 months ago | |
src | 3 months ago | |
static | 2 months ago | |
.gitignore | 3 months ago | |
.yarnrc.yml | 3 months ago | |
README.md | 3 months ago | |
babel.config.js | 1 year ago | |
crowdin.yml | 2 months ago | |
docusaurus.config.js | 3 months ago | |
package-lock.json | 3 months ago | |
package.json | 3 months ago | |
sidebars.js | 1 year ago |
README.md
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/