How to do the Jekyll Post

Posted by Henry on March 07, 20

Jekyll is a website building tool to turn Markdown files (like this one) into websites.

Markdown

Posts are written in markdown, which is basically plain text. You can read through this or that, but here are some basic examples.

Headers

There are six levels of headers:

# Header

## Sub-Header

### Sub-Sub-Header

#### You Get the Point

##### There Are 6 of These

###### Yes, This is the Last One

Basically, the more #’s there are, the bigger the header is. Remember to put a space after headers.

Styling

*italics* or _italics_
**bold** or __bold__
***italic and bold*** or ___italic and bold___

`this is an inline code block`

```
This is a code block without any syntax highlighting.
```

```javascript
// This is a code block with JavaScript syntax highlighting.
// Many programming languages are supported.
// Write its name or sometimes its file extensions after the first set of backticks as seen here.
// For example, you could write `js` instead of `javascript`.
// For Ruby syntax highlighting, you could use `rb` or `ruby`.
```

Lists

1. This is an ordered list.
2. You write them like this.
3. Three.

* This is an unordered list.
* Foo.
* Bar.

- This is also an unordered list.
- You get the idea.
- Right?

Remember to surround lists in spaces.

Links

[This is a link to a URL (this text is shown instead of the URL).](https://example.com)

![This is the alternate text for this image (this text is shown when the image cannot be loaded, or it is used for accessibility).](https://placehold.it/400/400.png)

Metadata

Each post has YAML metadata at the very top of the file called front matter. Here are some examples.

---
layout: post
title: "Building the Cool Wheelz Deluxe: Guide, Tutorial, and How-To"
author: "Robotics Guy"
categories: [Programming, Engineering]
---

---
layout: post
title: "How to Find the Village Witch: The Ultimate Guide"
author: "Greta, the Village Elder"
categories: [Outreach]
---

Remembers to surround the front matter in ---’s!

Putting it All Together

---
layout: post
title: "How to do the Jekyll Post"
author: "Henry"
categories: [Programming, Outreach]
---

Jekyll is a website building tool to turn Markdown files (like this one.) into websites.

## Inception

* Wow!
* Look at this!
* A post inside of a post.
* How incredible!

## Steps to do the Jekyll

1. Read this post.
2. Put on your big brain cap.
3. Write a post in Markdown.
4. ???
5. Profit!

[Check out our website!](http://arcturusrobotics.com)

You don’t have to put a top-level header in there,because Jekyll does it for you! The title in the front matter is used to generate a header.

Making the Post

Create a file in _posts in the website’s repository.
Name it in the format of yyyy-mm-dd-your-title-here.md. Remember to write 2020-03-07 and not 2020-3-7 (this is probably important).
Write your post. Remember to include front matter and to use proper Markdown syntax.
Add, commit, and push your work to the GitHub repository.
You’re finished!