Research Dugnads HQ

Welcome to Research Dugnads HQ! You can find out everything about what Research Dugnads are and how to run them at our website. This README explains the tool to run the website locally and will point you to our Code of Conduct and Contributing Guidelines.

Table of Contents:

• Working with the Website Locally
  • Installing Hugo
  • Creating new content
  • Locally rendering changes
  • Changing the theme
  • Updating the theme
• Contributing

---

Working with the Website Locally

The website is built using a tool called Hugo

Installing Hugo

On MacOS using Homebrew, install Hugo using the following command.

brew install hugo

See Hugo's Installation Guide for other systems.

Creating new content

The below command will create a new content file with the appropriate headings.

⚠️ Make sure this command is run from the root of the directory.

hugo new path/to/new-content.md

Locally rendering changes

To see your changes locally, run the below command and then open localhost:1313 in your browser.

hugo server -D

Changing the theme

Select a new theme from https://themes.gohugo.io/ and run the following command, updating USERNAME and REPONAME as appropriate.

git submodule add https://github.com/USERNAME/REPONAME.git theme/REPONAME

Updating the theme

To pull in any upstream changes to the theme being used as a git submodule, run the following.

git submodule update --remote

Contributing

Thank you for participating in the Research Dugnads movement! Please make sure you have read our Code of Conduct before starting and checkout the Contributing Guidelines for tips on where to begin.