Skip to content

BattleTalent/community-docs

Repository files navigation

Website

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

Requirements:

This project runs on an older version of node and is not compatible with versions after 16. To easily switch you could use nvm.

nvm install 16
nvm use 16

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open 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

GIT_USER=<YOUR_GIT_USERNAME> USE_SSH=true 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.