Skip to content

Commit

Permalink
Adds some basic documentation for a few types.
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrythall committed Aug 30, 2024
1 parent 90b0d1d commit b1108db
Show file tree
Hide file tree
Showing 6 changed files with 110 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/_content/organizers/_ORGANIZER.md.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Firstname Lastname
hidden: false
photo: photo.jpg
role: "Assignment, Assignment"
social:
bluesky: handle
github: handle
instagram: handle
mastodon: https://url.com/
twitter: handle
website: https://url.com/
---
17 changes: 17 additions & 0 deletions src/_content/organizers/_ORGANIZERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Organizers

Organziers can be seen at `/organizers/`.

See `src/_includes/organizers-grid.html` for some common rendering of organizers.

Organizers can be hidden by setting `hidden: true` in the front matter.

## Adding a new organizer

1. Copy `_ORGANIZER.md.example` to a new file and name it `first-last.md` (e.g. `jane-doe.md`).
2. Fill in the details. You can remove any social networks that are unusued, or leave them blank. Note that `role` is a string, not a list.
4. Add the organizer's photo to the `src/_content/organizers` directory. The photo should be square (or at least portrait-shaped) and at least 600x600 pixels, in JPG or WebP format. The filename should be the same as the organizer's MD file, but with the extension `.jpg` or `.webp` (e.g. `jane-doe.jpg`).

## Deleting an organizer

Remove the organizer's MD file and respective photo from the `src/_content/organizers` directory.
18 changes: 18 additions & 0 deletions src/_content/places/_PLACE
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Places

Organziers can be seen at `/venue/#places`.

See `src/_includes/place.html` for rendering.

Places can be hidden by setting `hidden: true` in the front matter.

## Adding a new place

1. Copy `_PLACE.md.example` to a new file and name it `place-name.md` (e.g. `cool-spot.md`).
2. Fill in the details. Use quotes for strings (e.g. `"..."`) as some addresses may have breaking characters.
3. When adding a map link, use the "Share" link from Google Maps. The URL should look like `https://goo.gl/maps/...`.
4. Add the place's photo to the `src/_content/places` directory. The photo should be square (or at least portrait-shaped) and at least 400x400 pixels, in JPG or WebP format. The filename should be the same as the place's MD file, but with the extension `.jpg` or `.webp` (e.g. `cool-spot.jpg`).

## Deleting an organizer

Remove the place's MD file and respective photo from the `src/_content/places` directory.
11 changes: 11 additions & 0 deletions src/_content/places/_PLACE.md.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: "Location Name"
hidden: false
photo: photo.png
location: "111 Corcoran Street"
distance: "2 blocks (0.1 miles) away"
map: "https://goo.gl/maps/sHmC8kuSBycrRfek8"
website: "https://www.21cmuseumhotels.com/durham/"
---

140 character text description
16 changes: 16 additions & 0 deletions src/_content/posts/_POST.md.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
author: Firstname Lastname
hidden: false
category: Category
published_datetime: YYYY-MM-DD HH:MM:SS
cover:
url: /assets/img/blog/photo.jpg
alt: "Description of the photo"
title: "Blog post title"
---

Excerpt year, if used. Should be roughly 2-3 sentences.

<!-- excerpt -->

Long post here in Markdown format.
35 changes: 35 additions & 0 deletions src/_content/posts/_POSTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Posts

Posts can be seen at `/news/` and `/news/<post-id>`. Post cards appear in various spots on the website.

See `src/_layouts/post.html` for some common long form rendering.

Posts can be hidden by setting `hidden: true` in the front matter.

## Adding a new post

1. Copy `_POST.md.example` to a new file and name it `seo-friendly-post-slug.md` (e.g. `announcing-djangocon.md`).
2. Fill in the post metadata. Not all fields are shown every year. The most important fields are: `title`, `published_datetime`, and `cover`. `published_datetime` is used in sitemap.xml, RSS feed generation, and for sorting posts on the news page, so make sure it is accurate. `cover.alt` is used for accessibility.
4. Add post content in Markdown format.

### About cover photos

Cover photos are displayed at the top of the post, and depending on site design, could appear in other places. These are typically landscape in orientation, and for future planning are likely best sized as 1200x630 pixels in case they are ever used for social share graphics.

Cover photos are stored in `/assets/img/blog/`, and are treated like website assets and not necessarily data, as they may be used in multiple places on the site.

NOTE: Cover "photo" can also be a graphic or illustration. Any WebP, SVG, PNG, or JPG is valid.

### Adding content

* Use Markdown for formatting.
* The title of your document is your H1. The top-level heading in your content should be H2, or `##`.
* Use `<!-- excerpt -->` to define the excerpt that appears on the news page.
* You may use includes, e.g. `{% include "include.html" %}`.
* HTML is OK to use, but please use it sparingly.
* Photos you reference are not optimized. Be sure to process photos in advance.
* It's best to keep content simple!

## Deleting an post

Remove the post's MD file and any related photos from the `src/_content/posts` directory.

0 comments on commit b1108db

Please sign in to comment.