Building your Site
Note: this is only an introductory guide. Jekyll provides a great in depth step-by-step guide on how to build your website.
This file organizes how your your website is structured. Review the file’s documentation on how to fill this out for your website.
*Note: YAML files require a specific syntax. Refer here as a guide.
Pages are basic static pages. Pages are markdown files and can be named anything. However, you must include a header that looks like this on your pages.
--- title: /project layout: page permalink: /project ---
The title is the title of the page. The permalink is the relative link to the page. The layout is which layout to use in
Posts are specialized pages that let you organize your site like a blog instead of just a static website. You can even set up your blog so that it automatically lists all your posts with dates and a scrolling feed, depending on the theme you choose.
Posts should be stored under the directory
_posts as a
.markdown file. They must follow the following naming format:
In the file, you must also add a header at the top. Here’s an example:
--- layout: post title: "Game Development and Accessibility" date: 2020-02-29 01:44:05 -0500 tags: needs tech ---
Anything below this will be part of your post, and should be written in markdown.
Note: layout indicates that it will use the
post.html layout found in
Pages are written in markdown.
You can add inline code to your site with the following syntax:
This will highlight the code syntax separately like this:
To do a block of code, do this syntax (with the asterisk removed:
*``` printf("Inline code!"); *```
The end result will look like this:
There are two ways to post images. To do an inline image:
![alt text](/images/example_image.png "Hover text")
To do a reference-style image:
![alt text][logo] [logo]: /images/example_image.png "Hover text"
The end result in either case will look similar to this:
Note: Don’t forget to add alt text! Describe the image meaningfully to convey to users who can’t view the image.
If you want to share a download link, you can save your file to your repository, and either reference it in-line style:
Or reference style:
[Essay][download] [download]: /downloads/saul-newman-stirner-and-deleuze-s-anarchism.pdf
The end result will look like this: Essay
Testing Your Site
To test your site, you can deploy it locally by executing the following:
bundle exec jekyll serve
If all goes well, you can view your local website in the link the console provides you. If it gives you an error about needing to install the bundle packages, try running the following before trying again: