Contribute

This page is for describing how to add, improve, and update ACDC documentation.

Installation

The documentation is generated using the Hugo documentation generator. We recommend running below commands for each machine.

macOS/Linux

$ brew install hugo

Windows

$ choco install hugo-extended

Note that Hugo with Extended edition is required for building the documentation with current theme. Make sure you see /extended after the version number, once you run hugo version.

Getting started

Add new page

To add a new page, cd docs and run:

$ hugo new content content/docs/[new_page_name]/index.md

Open the file with your editor and add contents.

View site

To test your site, run:

$ hugo server

Now enter localhost:1313 in the address bar of your browser. The server rebuilds your site and refreshes your browser whenever it detects the change.