Skip to content

tudelft3d/kcod-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knowledge Centre Open Data — Website

Source for kcopendata.bk.tudelft.nl, built with Hugo.


Adding Content through Github

You can make changes to the content of the website by directly modifying files in github and committing the changes. Anything that is pushed or merged to main will be automatically published to the website after a few minutes.

How to add a news article

Navigate to content/news/ and press Add File to create a new .md file. The filename must start with the publication date in YYYY-MM-DD format, e.g. 2024-03-15-my-article-title.md.

The file should start with this information and format:

---
title: "Your article title"
date: 2024-03-15
years: ["2024"]
draft: false
---

Article content goes here.

The years field controls which year archive page the article appears under.

After you have added your content, press the commit changes button. You can then monitor the build status on the Actions page.

Publication (article, book chapter, etc.)

Add an entry to the appropriate YAML file in data/publications/, by pressing the edit button. Entries follow this structure:

- title: "Maatschappelijke kosten-batenanalyse open data"
  category: "reports"
  year: 2017
  author: "Welle Donker, F., van Loenen, B. and Korthals Altes, W."
  citation: "Welle Donker, F., van Loenen, B. and Korthals Altes, W. (2017). **Maatschappelijke kosten-batenanalyse open data**. Delft: OTB-Onderzoek voor de gebouwde omgeving. Faculteit Bouwkunde, TU Delft. 128 p."
  external_url: "https://pure.tudelft.nl/..."

After you verify your entry has the right format, press the commit changes button. You can then monitor the build status on the Actions page.

Local development

Run locally

git clone https://github.com/tudelft3d/kcod-website.git
cd kcod-website
hugo server -e development

Then open http://localhost:1313 in your browser.

Deploy changes

If you are working on your local repo, push your changes to the main branch and the website will be updated automatically.

git status                      # review changed files
git add <file>                  # stage changed files
git commit -m "Your message"    # commit with a descriptive message
git push                        # push to the remote repository

You can monitor the build status on the Actions page.

About

The new version of the KCOD website using Hugo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors