Skip to content

Cytooxien/Realms-Docs

Repository files navigation

Website

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

Installation

$ npm install

Local Development

$ docusaurus 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.

Local Development with german translations

$ docusaurus start --locale de

This command also starts a development server but with the german translations.

Build

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

Not using SSH:

$ GIT_USER=<Your GitHub username> 
$ npm run 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.

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •