About This Documentation

Introduction

This is a set of documents was built in Hugo, using the Hextra theme.

Hugo is an open-source static site generator that uses markdown files for creating and editing the main content.
Hextra is an open-source theme specifically developed to build documentation websites using Hugo.

Tip

You can download Hugo on any system, install it and use the commands to deploy the website.

File Path

The open files for the documentation are shared at :

Server path
\\path\to\sample-documentation

The content folder includes all the open files in Markdown language.

Hugo commands

  1. Command to host the website on the local browser :
    hugo server --openBrowser --disableFastRender --minify

  2. You can access the site using the following link :
    http://localhost:1313/

  3. Command to build the website :
    hugo --minify

Deployment

Caution

DO NOT to edit the documentation directly on the deployment server.
It is recommended to make a make the changes in the 10.10.rr.xxx > contents folder, and copy the updated files to deployed server only after testing it locally.

  1. 10.10.tt.yyy is a Linux based system.
    Contact IT Team to get access for the system.

  2. Copy the documentation files from 10.10.rr.xxx to 10.10.tt.yyy at the following path :
    \\path\to\data\sample-documentation

  3. To deploy the website, open terminal at the above mentioned path and run the following code :
    hugo server --disableFastRender --minify --bind 10.10.tt.yyy --baseURL http://10.10.tt.yyy/

Back to Home Page
Documentation