Table of Contents

• 1. Description
• 2. Prerequisites
  • 2.1. Install on Mac OS
• 3. How to generate the site

Description

The PRUNERS Website is developed using HUGO, Bootstrap 3 and HTML5.

It is a static website, all you need to do is fill up a Markdown page and re-generate the site.

Prerequisites

Only prerequisite is the HUGO engine.

Install on Mac OS

brew update && brew install hugo

For details go here.

How to generate the site

• Once you cloned the repository, you need to checkout the branch gh-pages.

• Modify your Markdown pages.

• From the root folder of the web site run:

  hugo --verbose && hugo --verbose serve
  

  This will generate the site and run a local server to verify that the new edits are correct.

• Once the site is ready to be published, from the gh-pages branch, run:

  ./scripts/publish_tomaster.sh
  

  This command will commit and push the modification on the master branch which is the branch that GitHub uses to publish the content of the website.