1
0
Fork 0
instructions for editing themes
Go to file
marcia 1d6ef86520 Upload files to "static/test_theme" 2024-05-29 21:25:52 +00:00
blog 1.14 2024-02-13 21:16:58 -08:00
build-staging 1.14 2024-02-13 21:16:58 -08:00
developing Fixup rust example 2023-04-27 12:12:07 -07:00
docs Update docs/contribute/themes.md 2024-05-29 20:39:13 +00:00
i18n Upgrade Docusarus, Fixup Markdown Issues 2024-01-04 13:42:21 -08:00
security 1.14 2024-02-13 21:16:58 -08:00
src Roadmap update draft, translate homepage features 2023-06-29 11:09:15 -07:00
static Upload files to "static/test_theme" 2024-05-29 21:25:52 +00:00
.gitignore Cache build staging due to memory usage build issues on docs. 2023-06-29 11:24:12 -07:00
.yarnrc.yml Update Docusaurus 2023-06-15 10:48:58 -07:00
README.md Update Readme 2023-06-15 12:10:43 -07:00
babel.config.js theme image 2022-06-17 13:29:10 -07:00
crowdin.yml Enable blog and developing translations 2023-07-27 09:00:25 -07:00
docusaurus.config.js Update Edit Link 2023-06-16 12:56:26 -07:00
package-lock.json Upgrade Docusarus, Fixup Markdown Issues 2024-01-04 13:42:21 -08:00
package.json Upgrade Docusarus, Fixup Markdown Issues 2024-01-04 13:42:21 -08:00
sidebars.js test stub 2022-05-11 13:53:53 -07:00

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/