Skip to content

Commit

Permalink
Merge pull request #291 from carpentries/readme-blogpost
Browse files Browse the repository at this point in the history
Update readme with general info
  • Loading branch information
maneesha authored Nov 18, 2024
2 parents 5a6510f + dbea082 commit 4469c25
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,32 @@ Run `make serve` in your project's folder to serve the site locally.

On 18 November 2024, this site was released using Hugo as the static site generator. This README section will be updated as we add in more information about how to use the new infrastructure.

### General content

General content is in one of the folders in the `content` folder. These folders are organized by theme. No new files should be created in the root of the `content` folder.

### Blog posts

Blog posts go in the `content/posts/YYYY/MM` folder. Images for the blog posts go in the corresponding `static/blog/YYYY/MM` folder. Note YYYY is the four digit year and MM is the two digit month.
**File names and location**
Blog posts go in the `content/posts/YYYY/MM` folder. Images for the blog posts go in the corresponding `static/blog/YYYY/MM` folder. Note YYYY is the four digit year and MM is the two digit month. Be sure the file location and the blog post date as defined in the yaml metadata (see below) match up.

The file name should **not** include a date.

**File metadata**

The file should begin with yaml metadata (data contained within three hyphens at the top of the file). An example is below:

The blog post date should be set in the file's front matter. Be sure the date and the file location match up.
```
---
layout: page
authors: ["Person One", "Person Two"]
teaser: "A short line describing the post that will display on the blog list page"
title: "Blog post main title"
date: 2024-11-18
time: "09:00:00"
tags: ["Data Carpentry", "Community"]
---
```

**Blog post tags:** Whenever possible, make sure the tags are from our [list of existing tags](https://carpentries.org/blog/posts-by-tags/).

0 comments on commit 4469c25

Please sign in to comment.