Skip to content

Markdown Pages

Chelsea Miya edited this page Jul 11, 2023 · 2 revisions

Located:

  • Exhibits and Events each have their own subfolder in the main directory.
pages-2
  • All other pages are in the 'pages' subfolder.
pages-1

Markdown

  • All pages (including exhibits and events) are saved as Markdown (.md) files.

What is Markdown?

  • Markdown is a lightweight coding language, used to format plaintext documents.
  • Markdown files can be edited directly on GitHub, like a word processor.
  • When the website is generated, the Markdown files are converted into HTML.
  • Markdown can also be combined with HTML and CSS stylesheets to add elements like images.
  • See: Markdown Cheatsheet

Markdown Frontmatter

  • The 'front matter' is located at the top of a Markdown page, in-between triple-dashes.
  • e.g.
---
layout: event
title: Conversation on Listening Methodologies with Kit Dobson
event_date: "2022-10-12"
event_time: 3:00-4:30 PM MT
event_end:
event_location: The University of Alberta
event_room: Salter Reading Room, HC-3-95
permalink: /events/conversation-on-listening-methodologies-with-professor-kit-dobson/
featured_image: /img/Kit-Dobson.jpeg
description: "Join us for a conversation with author Kit Dobson on methodologies of listening and the ways they might open up alternative forms for scholars."
---

Layouts

  • While page content is created and edited in Markdown... the page layout is built as a separate html files (See: Layouts).
  • The 'layout' has a special field in the Markdown front matter.
  • Use the 'exhibit' layout for exhibits, 'event' for events, and 'default' for all other pages.
  • e.g.
layout: default

Anatomy of a Jekyll Site

Updating the Website

Version Control

Additional Resources

Clone this wiki locally