Skip to content

Instruction on Creating a workshop with Jekyll system

Jump to bottom
Chu, Angdi edited this page Jul 1, 2019 · 2 revisions

Requirements

Step by Step

Create a new workshop post

The process of post creation is quick and simple.

  1. Create a new Makrdown file and place it in the _posts folder. This file must be named according to the post's date (yyyy-mm-dd) and title; any spaces must be replaced by a "-" e.g:
2019-05-25-this-is-a-new-workshop.md
  1. The post's content must be preceded by Front Matter, This will assign the post a layout, title, date, category, and permalink, as this Front Matter is written in YAML, it must be wrapped in "---" so Jekyll will know it doesn't form part of the text written in markdown e.g:
---
layout: post
title:  "Continuous Delivery Pipeline using Docker and Docker Cloud"
date:   2019-06-29
categories: [ workshop ]
permalink: /:categories/:year-:month/:title:output_ext
---

note that in this case, the layout, categories and permalink fields should not change between posts

  1. After the Front Matter data is set, all that's left is to write the content of the post in Markdown e.g: #title
    ###subtitle
    this is the content of the post and will appear below the title and the subtitle

For extra ease of use, I've created a base file that can be used to create new posts, you can download it from here: https://drive.google.com/file/d/1rEWbGCf9OZhCT4QoV9G2K6vv7crH5fVR/view?usp=sharing

Upload Poster

  1. Upload the poster image (.jpg, .jpeg, .png or .bmp) under /assets/workshops/ folder on Github.

  2. In the Markdown file that you just created, link the url of the image like this:

![Workshop Name](/assets/workshops/poster-06-29.jpg)

Notes and resources

  • For more information on how to write Markdown go here: https://guides.github.com/features/mastering-markdown/
  • HTML can be included in the content of the post and can be used to add extra styling and blocking
  • You can create the file with any text editor or IDE, I recommend using Brackets, Brackets is an open source and light IDE and can be downloaded from here: http://brackets.io/
  • Posts dated after the current date will not appear until the current date matches the date in the Front Matter.

Clone this wiki locally