Skip to content

bennycheung/bennycheung.github.io

Repository files navigation

How to Setup Jekyll Blogging

Edit Jekyll Configuration

This Jekyll _config.yml defines all the site's keys; change all the keys to your relevant information

Edit Link Pages

This set of pages, with layout pages, will show up in the sidebar navigation as links. By default, we have

  1. About - about.md tell something about you and your site
  2. Research - research.md list the research items

Write Blog Pages

Put your blog pages into _posts directory, with the proper YYYY-MM-DD-your-post-title.md as the file name format. Within the post, you should have at least the following metadata, the layout post should be used.

For example,

---
layout: post
title: YOLO for Real-Time Food Detection
date: 2018-06-07 01:00:00.000000000 -05:00
permalink: yolo-for-real-time-food-detection
author: Benny Cheung
artwork:
  author: Style of Kandinsky's TransverseLine transfer to food images
tags:
  - Deep Neural Network
  - Object Detection
  - YOLO
category: post
comments: true
image: images/yolo-for-real-time-food-detection/cover2x.jpg
images:
  cover: images/yolo-for-real-time-food-detection/cover.jpg
  header: images/yolo-for-real-time-food-detection/header.jpg
published: true
---

The image.cover metadata key is for the post's teaser image (assumed to be 400x300). The image.header metadata key is for the post's header image (assumed to be 800x160). You can find the samples in the _posts directory. For the social media site, define image will be appeared for the referred link from your social media post.

Post Excerpt

The tag <!--excerpt.start--> and <!--excerpt.end--> mark the beginning and the end of the excerpt in the post, that would be put on the post's summary block in the front page.

For example,

<!--excerpt.start-->
The obsession of recognizing snacks and foods has been a fun theme ...
<!--excerpt.end-->

Image Location

My site's organizational convention, all images referenced in the post should be placed in images directory, and refers to the image prefixed by {{ site.baseurl }}/images/.

Local Testing

You can install Jekyll locally, and serve the pages locally by running (--baseurl to override the configured site URL to nothing, make it able to run locally with all the links correctly points to localhost),

  jekyll server --baseurl ""

Now, you can navigate to localhost:4000 to view your blog pages.

alias jekyllserve='bundle exec jekyll serve --livereload'