This site uses the Defense Unicorns theme for Hugo. Read the theme docs for full details on adding content and site configuration. which is a fork of the Google Docsy theme. The Docsy documentation can be used as a guide for building content.
-
Install Hugo
-
Create a new repository from this template:
- Clone your new site:
git clone <git repo>
cd <new repo>
npm ci
To run the site for local development:
npm start
Then navigate to http://localhost:1313/
Check out the site's hugo.toml file for configuration options for things like social links, GitHub references, and how to activate and configure documentation versioning.
You can modify the color theme to match your product's by changing the $secondary
color variable in _variables_project.scss.
To modify the favicon, replace the Doug icons in static/favicons
with the icons of your choosing. You can use
IconGen to create the icons in the multiple sizes needed. Make sure and replace all of the sizes or it will default to Doug.
To modify the logo on your Navbar, change the navbar_logo
setting under params.ui
in hugo.toml
. The logo should be
an SVG.
This repository enforces Conventional Commit messages. See the
documentation for release-please
for
correctly formatting commit messages. This video does a
good job of showing how to add the Conventional Commit
VSCode extension to use when creating the commit messages.