Skip to content

How to work with Markdown

Maya edited this page May 25, 2016 · 13 revisions

Level Up content is added by uploading Markdown files with the correct metadata.

Folder structure

If you want to add or edit Level Up content, all files are accessible on Github. All pages that fall under You, the Trainer, Before an Event, Curriculum and After an Event are accessible in the _pages folder.

The Community Resources and Tools page and News and Updates pages are organized differently. The content lives in the _posts folder, in their corresponding folders (news, resources).

In the After an Event folder, you can see the root page and then two folders. The root page links to the two pages. All you need to do is add the metadata to the root page. This is the same structure for Before and After an Event and You, the Trainer. There is always a root page and then folders with every page.

The Curriculum pages are a bit more complicated. Check out the folder structure of the Mobile Safety page. Each topic has a root markdown file. Within the topic folder (i.e. Mobile Safety) there are folders that represent modules. Within the module folder (How mobile networks work), there is a root markdown file and folders for activity-discussion, input (etc). Each ADIDS category gets it's own markdown file or if there are multiple per topic then they get their own folders. See Malware Protection for a good example of this.

Metadata for Markdown

All pages are written in Markdown. See the raw files in the repo for reference on what they should look like.

When adding a new page or post make sure that it has the correct front matter or metadata. Below are examples and templates.

Example Before an Event metadata:

This is the only markdown file for a Before an Event page. The same metadata structure applies to You, the Trainer and After an Event.

---
layout: content-page
title: "Creating Safe Spaces"
author: Sandra Ljubinkovic
summary: "Training can be an emotional experience, in particular for participants experiencing constant stress or trauma. As a trainer, creating a safe space is the basis for your work, crucial for creating a sense of physical safety as well as a sense of confidence in a group."
date: 08/00/2014
permalink: /before-an-event/creating-safe-spaces/
parent: Before an Event
breadcrumb: Creating Safe Spaces
---

Example Curriculum index metadata:

This page aggregates all mobile safety modules.

---
layout: page-index
title: "Mobile Safety"
author: To be updated
summary: "To be updated"
date: 2016-05-00
permalink: /curriculum/mobile-safety/
parent: Curriculum
breadcrumb: Mobile Safety
---

Example Module index metadata:

This is an example of a mobile safety module. The metadata is different because it includes ADIDS information and metadata values like Platform and Level.

---
layout: module
title: "How Mobile Networks Work"
author:
date: 03/00/2016

activity:
  - name: "Where Am I?"
    url: /curriculum/mobile-safety/how-mobile-networks-work/activity-discussion/where-am-i/

input:
 - name: "Mobile Devices: How Do They Work?"
   url: /curriculum/mobile-safety/how-mobile-networks-work/input/how-do-mobile-devices-work/

deepening:
 - name:
   url:

synthesis:
 - name:
   url:

platforms:
level: Fundamental
prerequisites:
permalink: /curriculum/mobile-safety/how-mobile-networks-work/
parent: Mobile Safety
breadcrumb: How Mobile Networks Work
---

Example of ADIDS metadata within curriculum:

This is an example of an activity and discussion page so it includes metadata like duration and adids type.

---
layout: content-page
title: "Activity & Discussion: Where Am I?"
author: Alix Dunn
summary: "This is an activity that illustrates how mobile devices communicate with mobile networks, highlighting how locations of mobile devices are triangulated as part of routine communication with these networks.This leads into a discussion that will get participants thinking critically about the implications of the geolocation and tracking capabilities of mobile devices."
permalink: /curriculum/mobile-safety/how-mobile-networks-work/activity-discussion/where-am-i/
breadcrumb: "AD: Where Am I?"
date: 2014-03-00
adids: Activity and Discussion
parent: Basics of Mobile Devices
duration: 30-45 minutes
---

Example news metadata:

---
layout: news
title: "Title for the news"
date: 2016-04-11
author: Dev
summary: "This is a summary."
published: true
category: news
permalink: /news/2016-04-11-test/
breadcrumb: Title for the news
---

Example community resource metadata:

---
layout: resource
title: "Does This Work?"
date: 2016-04-11
author: Dev
summary: "Testing"
published: true
category: resources
permalink: /community/community-resources-and-tools/2016-04-11-community/
breadcrumb: Resources
---

You, the Trainer/Before an Event/After an Event Metadata Template

---
layout: content-page
title: ""
author: 
summary: ""
date: MM/DD/YYYY
permalink:
parent:
breadcrumb:
---

Curriculum Metadata Template

---
layout: module
title: ""
author: 
date:

activity:
  - name: 
    url: 

input:
 - name: 
   url: 

deepening:
 - name:
   url:

synthesis:
 - name:
   url:

platforms:
level: 
prerequisites:
permalink: 
parent: 
breadcrumb: ""
---

ADIDS within Curriculum Metadata Template

---
layout: content-page
title: ""
author: 
summary: ""
permalink: 
breadcrumb:
date: 
adids: 
parent: 
duration: 
---

News Template

---
layout: news
title: ""
date: 
author: 
summary: ""
published: true
category: news
permalink: /news/
breadcrumb:
---

Community resource Template

---
layout: resource
title: ""
date: 2016-04-11
author: 
summary: ""
published: true
category: resources
permalink: /community/community-resources-and-tools/
breadcrumb: Resources
---
You can’t perform that action at this time.