Skip to content

Xceptance/xlt-documentation

Repository files navigation

XLT Documentation

XLT Documentation is based on Docsy. Docsy is a Hugo theme for technical documentation sets, providing simple navigation, site structure, and more.

Prerequisites

The following are basic prerequisites:

  • Install a recent release of the Hugo "extended" version (we recommend version 0.131.0 or later). If you install from the release page, make sure you download the _extended version which supports SCSS.

  • Install the current Node environment (version > 14.x).

  • Install all further dependencies by executing npm ci on the console within the documentation's root folder.

Build

Build and deploy to a local webserver:

hugo server --watch --disableFastRender

Just build:

hugo

The default address for your build will be localhost:1313. If you need to change the port for some reason, use:

hugo server --watch --disableFastRender --port 2626