Skip to content

README.md

Latest commit

 

History

History
83 lines (58 loc) · 2.17 KB

README.md

File metadata and controls

83 lines (58 loc) · 2.17 KB

DevIQ.com - a Hugo site

DevIQ.com

Previous Gatsby Repo

Before opening a pull request, be sure to read this Pull Request Etiquette blog post.

Prerequisites

choco upgrade hugo-extended

Build and Run Locally

From the repository root:

  1. Start the local dev server (includes draft content):
hugo server -D
  1. Open the local site (default): http://localhost:1313/
  2. Build a production version:
hugo build
  1. Optional: lint markdown content files:
markdownlint content/

Add a New Article

  1. Choose the correct section folder under content/ (for example: antipatterns, principles, practices, testing).
  2. Create a new page using a kebab-case slug:
hugo new content/<section>/<slug>.md

Example:

hugo new content/principles/example-principle.md
  1. Update frontmatter. Most pages include at least:
---
title: Example Principle
date: 2026-03-14
description: One or two concise sentences summarizing the article.
params:
	image: /principles/images/example-principle.png
weight: 10
---
  1. Add the article body content, links, and references.
  2. Run hugo server -D and verify the page renders and appears in the expected section.
  3. When the article is ready to publish, ensure draft is removed or set to false.

Creating a Featured Image

We have a process for creating a featured image using Canva:

  1. The DevIQ template is read-only on Canva. Make a copy of the file in Canva by going to File > Make a copy.
  2. Update the title.
  3. Find an appropriate background by going to Elements > Photos and search.
  4. Drag the photo to the canvas, towards the middle of the image.
  5. Right-click on the image and select Replace background.
  6. Download the image and save it in the respective images folder.
  7. Update the frontmatter for the new page with the correct file name.