Skip to content

buildersoftio/andyx-docs

Repository files navigation

Andy X

Welcome to Andy X Documentation

Welcome to thye Buildersoft Knowledgebase Repository! This Knowledgebase was established for Buildersoft Engineers and Andy X Community members to work together to find common solutions.

Submissions and merges to this repository are distrubuted at {to add later}. This knowledgebase is licensed under Apache 2.0. Contributors who submit to the Buildersoft Knowledgebase for Andy agree to the Buildersoft Contribution License Agreement.

How This Site is Rendered

This site is rendered using Hugo and the Doks theme.

To test out the site on a local system:

  1. Download the entire repo.
  2. Install hugo.
  3. From the command line, run npm install to allocate the proper packages locally.
  4. From the command line, run git submodule update --init --recursive to populate the Docsy theme.
  5. Edit the contents of the ./content/en directory. To add images/pdfs/etc , those go into ./static.
  6. To view the web page locally to verify how it looks, use hugo server and the web page will be displayed from ./docs as a local server on http://localhost:1313.