Skip to content

README.md

Latest commit

 

History

History
61 lines (40 loc) · 1.89 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.89 KB

go-home.io website

Netlify Status Build Status

Static generation

Website is statically generated, using Hugo and based on the awesome Kube theme.

To install Hugo, refer to official documentation.

Creating a new entry

hugo new --kind kind kinds/type/name.md

Where kind is one of:

  • system -- supported system overview
  • device -- supported device description
  • doc -- generic documentation
  • app -- helm-based application

For example, creating a new trigger provider should looks like

hugo new --kind system systems/trigger/state.md

If you're creating a new type of system/device/etc., _index.md should be used as a name. This document describes generic parameters related to all providers.

For example, creating a new service bus system should looks like:

hugo new --kind system systems/bus/_index.md

Running a server

After adding required pages, simply run

hugo server -D --ignoreCache --noHTTPCache --verboseLog --verbose

Hugo tracks all changes made to files and re-generates html, so no need to restart server upon changes.

Linter

To verify documents, please use markdownlint before commit. Even tho deployment to Netlify won't fail, Travis's CI build will.

Make targets

  • install-linter -- installing linter cli
  • lint -- running linter
  • hugo -- running Hugo dev server (current version is 0.57.2)