I need to be:
Link to markdown parser documentation [Kramdown]
Link to jekyll templating language [liquid]
Create a new markdown file in collect/_people/ . Add the following to the top of it, (including dashes) and fill out required values.
---
layout: person
name: [full name of person]
role:
[category to be listed under, as per how it appears in _data/pCategory.yml]
projects: (optional) [project 1's set name], [project 2's set name]
link: (optional) [external link instead of internal profile page]
---
You can then follow this with any amount of markdown you’d like to describe the person.
Note the only required fields for a person are layout, name and role. Adding a link variable will replace the internal page link with an external one.
To set the image of a person, drop the image into assets/images/ . Make sure to rename the image to the persons name value in lowercase, and spaces set to underscores.
eg. name: Jane Doe Will request an image called jane_doe.[image extention]
Simply append your category to _data/pCategory.yml in the format
- name: [category's name]
Create a new markdown file in collect/_projects/ . Add the following to the top of it (including dashes) and fill out required values.
---
layout: project
name: [the name of your project]
topic: [name of topic to attach the project under]
description: [short project description]
title: [changes the displayed tab name]
---
You can then follow this with any amount of markdown you’d like to describe the project.
Open the file _data/externalProject.yml and attach your projects details appropriately in the format.
- topic: [name of topic to attach the project under]
name: [name of project being attached]
description: [short project description]
link: [the link address]
Create a new markdown file in collect/_research/. Add the following to the top of it (including dashes) and fill out required values.
---
layout: topic
name: [put your topic name here]
title: [changes the displayed tab name]
---
You can then follow this with any amount of markdown you’d like to describe the topic.
To add a main page, simply add a markdown file to the site’s main directory. To add a link to it in the nav bar, add its address to the data/navigation.yml file.
- name: [link name]
link: [file name].html
If the nav items name already has an existing collection with the same name, simply add the drop variable. For example:
- name: People
link: people.html
drop: yes
As long as there is a collection existing with the name value lowercase (eg. people). A drop down menu will be generated with links to the items in the collection. Note that dropdown menus are not displayed on mobile.
default - Will simply output the content unformatted and center aligned. This layout is designed as a gateway for other layouts, therefore this layout is not reccommended for using with content directly.
people - Any content will be output normally. Then a list of the people in the peoples collection will be output and formatted in a tidy manner.
person - Name and role values will be displayed next to an image that’s src is derived from the image name. Any input content will then be attached below this, followed by a table of projects that have been listed in the person’s front matter.
plain - Outputs the content as plain text aligned to the left.
project - Output content as plain text, then attach a link back to the topic the project is related to.
research - List all the items in the research collection each with a link to their respective topics. Every second research item has an off-white background colour.
sections - Split the content based on input <!--split--> tags. Every second section has it’s background colour set to off white.
topic - Display input content and then list all projects associated with the topic in a table.
Modify _config.yml by adding the collections name under the collections: variable. Adding the output: variable allows you to output individual pages for each collection entry if you set it to true.
eg.
collections:
people:
output: true
research:
output: true
Note sometimes using tab characters can break this, use spaces instead.
Then create a new directory in collect/ for your collection with the same name as your collection, with an underscore in front of it.
eg. collect/_people and collect/_research
The website can be run locally from docker:
$ docker run --rm \
-e "JEKYLL_ENV=docker" \
--volume="$PWD:/srv/jekyll:Z" \
--publish [::1]:4000:4000 \
jekyll/jekyll \
jekyll serve \
--config _config.yml,_config.docker.yml
Your site should now be hosted at http://localhost:4000/