Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.16 KB

README.md

File metadata and controls

38 lines (24 loc) · 1.16 KB
Raw

The Good Docs Marketing Site

A Hugo based site using the docsy theme for the Good Docs Project.

Setup Local Environment

Quick instructions for getting started if you're on Mac OSX.

Requirements

  • Brew installed
  • NodeJS installed

CLI Instructions

These are the step-by-step instructions one can execute to configure a local environment. Note: This does use a git submodule for the Docsy theme, so using the correct git clone command is important.

# Installs the Hugo Binary that will be used to build and run the Hugo Server
brew install hugo

# Clone the repo locally
git clone --recurse-submodules --depth 1 [email protected]:thegooddocsproject/website-hugo.git

# Enter the default working path
cd website-hugo

# Installs the CSS processor
npm install

# Run the build process/http service
hugo server

Working Groups Content

For guidance on the purpose, operation and creation/maintenance of site content for Working Groups see Working Group Guidelines in the Governance repository.