Skip to content

Projects

Matt Luckcuck edited this page Dec 2, 2020 · 2 revisions

This page is about adding/managing the projects section of the website.

Each project is represented by a markdown file in the _projects folder. Each project has an item on the projects page.

At the moment, if you want a project to have its own page as well, you need to add a separate markdown file to the projects folder.

Adding a New Project

This adds a new project listing in the projects page, and adds a new page for the project.

Listing on the Projects Page

This is all you need to do if the project has an external website that you want to link to.

To add a new project to the website's projects page, make a new markdown file in the _projects folder (note: not the projects folder). This will generate a project description on the projects page. The title of this file should be descriptive, but it's not displayed anywhere on the site.

The file should have the following header:

---
title : "project title"
---

The "project title" will be the header of the project description on the projects page. Add the text describing the project to the body of this file. Then push the new file to the master branch.

Separate Project Page

This is for if the project needs an internal web page as well as an item in the projects list.

To add a new project page to the website, add a new markdown file to the projects folder (note: not the _projects folder). This will generate a new page for the project.

The markdown file should have the following its header:

---
layout: project
title: "page title"

---

The project layout will add a link back to the projects list at the top of the project page. The title will be displayed at the top of the page.

Add the text describing the project to the body of this file. Try looking at the existing project page in the projects folder for an example. Then push the new file to the master branch.

When a Project Ends

When a project has ended, simply move its description file from _projects to _projects-previous. This will move the project's description from "Current Projects" to "Previous Projects" on the projects page. Then push the change to the master branch.

Clone this wiki locally