Hugo Netlify Starter

Overview:

The CNCF Hugo Starter is a boilerplate setup for creating CNCF documentation projects. It includes a static site generator using Hugo, a CSS framework using Bootstrap 4.5.x, and hosting and DNS management using Netlify. While this setup is recommended for CNCF documentation projects, it is not strictly required as the technologies in the stack can be customized.

Features:

• Hugo as a static site generator
• Bootstrap 4.5.x as a CSS framework
• Netlify for building, hosting, and DNS management

Installation:

To run the CNCF Hugo Starter locally, follow these steps:

1. Make sure you have npm installed.
2. Clone the repository to your local machine.
3. Run the following two commands in the repository’s directory:

npm install
hugo server -D

To deploy the site on Netlify, follow these steps:

1. Sign up on netlify.com using your GitHub account.
2. Click “New Site from Git” and grant Netlify access to your GitHub account. (Note: For projects with multiple contributors, it is recommended to create a general/bot account instead of using a personal account.)
3. Install Netlify with access to your documentation site repository.
4. Leave all other settings as default and click “Deploy Site”.

Summary:

The CNCF Hugo Starter provides a pre-configured setup for CNCF documentation projects using Hugo, Bootstrap, and Netlify. It offers easy installation both for running the site locally and deploying it on Netlify. The repository includes minimal styling with two layouts for a homepage template and a docs template. Both templates utilize default components and styling from the Bootstrap CSS framework.