Newsletter Upload Guide

This guide explains how to upload newsletters so they appear on the correct classroom pages.

Quick Steps

  1. Save your newsletter file in the correct classroom folder under /assets/newsletters/
  2. Edit the classroom file in /_classrooms/ to add the newsletter entry
  3. Commit and push your changes

Supported File Types

Newsletters can be uploaded in any of these formats:

Step 1: Save the Newsletter File

Each classroom has its own folder. Save your file in the correct location:

Classroom Folder Path
Kindergarten /assets/newsletters/kindergarten/
Grade 1/2 A /assets/newsletters/grade-1-2-a/
Grade 1/2 B /assets/newsletters/grade-1-2-b/
Grade 3/4 /assets/newsletters/grade-3-4/
Grade 5/6 /assets/newsletters/grade-5-6/
Grade 7/8 /assets/newsletters/grade-7-8/

Naming Convention

Use this format: YYYY-MM-newsletter.ext

Examples:

Full path examples:

Step 2: Edit the Classroom File

Open the corresponding classroom file in /_classrooms/:

Classroom File to edit
Kindergarten _classrooms/kindergarten.md
Grade 1/2 A _classrooms/grade-1-2-a.md
Grade 1/2 B _classrooms/grade-1-2-b.md
Grade 3/4 _classrooms/grade-3-4.md
Grade 5/6 _classrooms/grade-5-6.md
Grade 7/8 _classrooms/grade-7-8.md

Add the Newsletter Entry

Find the newsletters: section in the file’s front matter (the part between the --- lines at the top).

IMPORTANT: Add new newsletters at the TOP of the list. The first newsletter is automatically displayed as the “Current Newsletter” with a thumbnail preview.

newsletters:
  - month: "February 2025"                                      # Required
    title: "Winter Fun & Learning"                              # Optional
    file: /assets/newsletters/kindergarten/2025-02-newsletter.pdf  # Required
    type: pdf                                                   # Required: pdf, png, or jpg
    description: "This month we're learning about..."           # Optional
  - month: "January 2025"
    title: "Welcome Back"
    file: /assets/newsletters/kindergarten/2025-01-newsletter.png
    type: png

Field Reference

Field Required Description
month Yes Display text for the month (e.g., “January 2025”)
title No Optional title for the newsletter
file Yes Path to the file (starts with /assets/newsletters/classroomname/)
type Yes File type: pdf, png, or jpg
description No Brief description shown with the current newsletter

Step 3: Commit and Push

After saving your changes:

git add assets/newsletters/kindergarten/2025-02-newsletter.pdf
git add _classrooms/kindergarten.md
git commit -m "Add February 2025 newsletter for Kindergarten"
git push

Complete Example

1. Save the file

Save 2025-02-newsletter.png to /assets/newsletters/grade-3-4/

2. Edit _classrooms/grade-3-4.md

Before:

newsletters:
  - month: "January 2025"
    title: "New Year New Learning"
    file: /assets/newsletters/grade-3-4/2025-01-newsletter.pdf
    type: pdf

After (add new entry at TOP):

newsletters:
  - month: "February 2025"
    title: "Black History Month"
    file: /assets/newsletters/grade-3-4/2025-02-newsletter.png
    type: png
    description: "Celebrating Black History Month and learning about influential figures."
  - month: "January 2025"
    title: "New Year New Learning"
    file: /assets/newsletters/grade-3-4/2025-01-newsletter.pdf
    type: pdf

How It Works

Troubleshooting

Newsletter not showing up?

Image not displaying as thumbnail?

Getting YAML errors?

Tips