Improve "Generic Markdown Layout"

Code-the-Dream-School / school-pages

static content for CTD students

https://school-pages.codethedream.org/

4 stars 6 forks source link

Improve "Generic Markdown Layout" #4

Open jdevries3133 opened 1 year ago

jdevries3133 commented 1 year ago

This will be the default layout for makdown content for all courses (to start).

Here are some ideas for making it better:

adding a header
adding a sidebar
adding a footer
adding more frontmatter metadata to enrich the page, like "publish date," "last updated," etc
related, as the default layout implicitly makes some frontmatter properties "required" (or else the page doesn't look great), write some validation logic for parsing; maybe take inspiration from https://github.com/jdevries3133/jackdevries.com/blob/main/app/services/post/validateMdxModule.ts
add links to invite potential contributors back to this repo
add dark mode / light mode toggle (probably something we want site-wide actually)

JamieBort commented 1 year ago

Hi, @jdevries3133 If this one doesn't have a time sensitive deadline please assign it to me. I'll attempt to knock it out within two weeks.

jdevries3133 commented 1 year ago

Some of this was done already -- I think the next item on the list here would be dark mode or better frontmatter tags for meta / open graph tags (including validation).

Want to pick 1 of those 2 to start with?

JamieBort commented 1 year ago

Sure. I'll start with those two, dark mode or better frontmatter tags for meta / open graph tags (including validation). Thanks!

JamieBort commented 6 months ago

Hi, @jdevries3133 . I dropped the ball on this one. Does this still need to be addressed? If not, are there other CtD repos that have outstanding Issues to be addressed? I see there are 1.1k CtD repos and I am not sure of an efficient way to see a list of CtD Issues all in one location.

jdevries3133 commented 6 months ago

Dark mode and frontmatter tags may still need to be done; I'm not aware of that being completed.

jdevries3133 commented 6 months ago

You may also consider contributing reviewer notes for the node course.

JamieBort commented 6 months ago

Please forgive me. I don't have a clear idea of what is needed to be addressed. Please let me know if the following is already explained somewhere. I'll happily read that before proceeding with any more questions.

I see that the root readme file has this front matter:

---
layout: "../../layouts/genericMarkdownFile.astro"
title: <your title>
description: <your description>
---

And I've added this to it:

publish date: YYYY-MM-DD
last updated: YYYY-MM-DD
author: <your name>

But I also see that layout: "../../layouts/genericMarkdownFile.astro" is in many (if not all?) markdown files just as it is written here.

Should that front matter be updated as well? Should layout: be different in each of those markdown files?

jdevries3133 commented 6 months ago

The goal is just for pages to have open graph tags for description, thumbnails, created / last updated dates, etc.

As far as the exact mechanics for achieving this in astro, I'm not sure, and I'd point you to the astro docs!

JamieBort commented 6 months ago

Thanks for that clarification. I'll read up on the documentation, open graph tags, etc.