Skip to content

feat(wasp-99): Setup Hugo Mod Usage

Simpson, Robert (Contractor) Evan requested to merge rsimpson/wdfn-viz:testing-hugo-mod-integration into main

Before making a pull request

  • Make sure all tests run
  • Update the changelog appropriately
  • Verify that the version in package.json indicates your intent to publish a release or snapshot build.
  • If making a release, update the version number and metadataLastUpdated in code.json.

Title

Description

This removes the dist directory from the .gitignore so it can be available when being consumed as a go mod in Hugo. The dist directory is needed to be part of the repository when go get is invoked. A similar example is Bootstrap in that they have the dist directory available in the repository.

Example of the integration can be found at https://water-services-dev.dev-wma.chs.usgs.gov/

This has been added to the bottom of the README.md with instructions on how to use as Go module.

To use the WDFN theme for your own site:

  • Add the go mod in the [module] section of your config.toml file.
[[module.imports]]
  path = "code.usgs.gov/wma/iow/wdfn-viz"
  disable = false

Now that it is imported, you can mount any of the files/directories needed. Example,

[[module.imports.mounts]]
    source = 'dist'
    target = 'static/wdfn-viz'

After making a pull request

  • If appropriate, put the link to the PR in the JIRA ticket
  • Assign someone to review unless the change is trivial

Merge request reports