Defense Unicorns Hugo Theme

Theme Demo

Forked from Docsy, a Hugo theme for technical documentation.

Use the Documentation Template to build a new product docs site.

Prerequisites

The following are basic prerequisites for using this theme:

• Install a recent release of the Hugo "extended" version. If you install from the Hugo release page, make sure you download the _extended version which supports SCSS.

• Install PostCSS so that the build can create the final CSS assets. You can install it locally by running the following commands from the root directory of your project:

  npm i -D autoprefixer postcss-cli

• Add the theme as a Hugo module

  hugo new site my-new-site
  cd  my-new-site
  hugo mod init github.com/me/my-new-site
  hugo mod get github.com/defenseunicorns/defense-unicorns-hugo-theme
  cat >> config.toml <<EOL
  [module]
  proxy = "direct"
  [[module.imports]]
  path = "github.com/defenseunicorns/defense-unicorns-hugo-theme"
  [[module.imports]]
  path = "github.com/defenseunicorns/defense-unicorns-hugo-theme/dependencies"
  EOL
  hugo server

Documentation

You can use Hugo to generate and serve a local copy of the user guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above:

git clone --depth 1 https://github.com/defenseunicorns/defense-unicorns-hugo-theme.git
cd defense-unicorns-hugo-theme/userguide/
npm install
npm run serve

Design

• Page Design
• Unicorn Color Pallette

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details