DFD Hugo minimal test theme

DFD Hugo minimal test theme

Status

build-and-verify pre-commit.cistatus build-and-deploy monthly-external-link-check

Demo/sample website

https://test-umbrella.wildtechgarden.ca/minimal-test-theme/

Repository URL

https://github.com/danielfdickinson/minimal-test-theme-hugo-dfd

Overview

Daniel F. Dickinson, uses this theme for demo/test sites for the modules on which he works. For a repository for creating minimal reproducible test cases see either the v0.3 branch of this repository or hugo-testing by jmooring from the Hugo forums. That use case was previously a goal of this repository, but such is no longer true.

See LICENSE for permissions on use.

Modern hugo only

This minimal theme is built using assumptions that may require Hugo 0.80.0 or higher, and in any event those are the only versions on which it has been tested.

Available features

hello-world shortcode

A simple shortcode that emits an HTML paragraph with ‘Hello World!’. To use it, add {{< hello-world >}} to a content file (not template).

page-assets shortcode

Allows rendering a Hugo resource from the assets directory as Markdown. This is currently used to render this repo’s README.md on a page in the exampleSite.

In order to be compliant with current HTML best practise for h1 elements, which is to have only one h1 element per page, any H1 elements in the asset are rewritten as H2 elements (because this theme adds the page title as an H1 element).

Basic usage (as theme)

Hugo module (preferred)

  1. Initialize the Hugo module system: hugo mod init github.com/<your_user>/<your_project>; (assuming you are using GitHub, of course).

  2. Import the theme in your config.toml

    [module]
    [[module.imports]]
    path = "github.com/danielfdickinson/minimal-test-theme-hugo-dfd"
    
  3. Change back to the site directory

  4. Get the module

    hugo mod get github.com/danielfdickinson/minimal-test-theme-hugo-dfd
    
  5. To test the result, run the local Hugo server

    hugo server -b http://localhost:1313/
    

Using git submodules (unsupported by theme author)

  1. Make a themes directory and switch to it.

    mkdir themes
    cd themes
    
  2. In the themes directory, add minimal-test-theme-hugo-dfd as a submodule

    git submodule add -f https://github.com/danielfdickinson/minimal-test-theme-hugo-dfd.git
    
  3. Change back to the site directory

  4. To test the result, run the local Hugo server

    hugo server -t hugo-minimal-test -b http://localhost:1313/
    

Enjoy!

Page and/or site params available

In/via this module

ParamDescription
showTopBarIf false, do not show top menu bar
testStylesIncludeIf true adds a very small amount of CSS to improve theme usability.

Test CSS styling

This makes the theme more usable

To enable the styles:

In config.toml add

[params]
	testStylesInclude = true

Getting help, discussing, and/or modifying


Colophon