defenseunicorns / doc-site-template

Template repository for creating product documentation

Doc Site Template

This site uses the Defense Unicorns theme for Hugo which is a fork of the Google Docsy theme. The Docsy documentation can be used as a guide for building content.

Contributing

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.

Prerequisites

Hugo is required in order to utilize the doc site template. You can run brew install hugo to quickly install or see the installation page for additional install methods.

Getting Started

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/

Style guide

You can modify the color theme to match your product's by changing the $secondary color variable in _variables_project.scss.

Color Palette

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 use the theme's default of 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.