DNB Hugo Garuda Template - a working sample template you can use for your own site
|❗ This documentation is work in progress and can change in parts over time.|
See dnb-hugo-garuda-template for an example repo that you can use as a template to work with this theme. You can fork that repo without adding all the revisions to date. Please keep issues related to this template in this themes repository .
npm installto install packages
./scripts/copy-files.shto copy used library to the assets folder
git submodule update --init --recursivein the root folder
./scripts/convert youtube VIDEOIDto load video thumbnail into static folder
Setup and update Algolia search
- fill in the info from https://www.algolia.com/apps > API keys
npm install -g atomic-algoliato install globally
npm run algoliawhenever there are updates to the content
Deployment to Netlify
This repository adds a deployment configuration to work with Netlify.
Set SNYK plugin
Netlify’s SNYK plugin checks all pages for possible security issues. If you do not want to use it look for the following lines in your netflix.toml (around line 50) and remove them:
# https://github.com/snyk-labs/netlify-plugin-snyk [[plugins]] package = "netlify-plugin-snyk"
If you want to use this plugin (recommended) then you need to set up an API key for it to properly work.
- see their documentation for information on how to retrieve an API-key
- add SNYK_TOKEN with the just retrieved key at Deploy Settings > Environment Variables in your Netlify site.