The official Husarion documentation

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

Requirements

Ensure you have the latest version of Node installed. It is also recommended to install Yarn as well.

• Node.js version >= 12.13.0 (which can be checked by running node -v).
• Yarn version >= 1.5 (which can be checked by running yarn --version).

(based on https://docusaurus.io/docs/installation)

Init submodules

git submodule update --init --recursive

Installation

yarn

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.

Build and serve static docs with Docker & Nginx

docker-compose up --build

visit http://localhost:3000