Blog

23 Jun 2021 / 2 minutes

Installation

Fork the repo
Edit _config.yml file.
Remove posts from _posts folder and add yours.
Edit index.md file in about folder.
Change repo name to YourUserName.github.io

That’s all.

Site Setup

A quick checklist of the files you’ll want to edit to get up and running.

Site Wide Configuration

_config.yml is your friend. Open it up and personalize it. Most variables are self explanatory but here’s an explanation of each if needed:

title

The title of your site… shocker!

Example title: My Awesome Site

bio

The description to show on your homepage.

description

The description to use for meta tags and navigation menu.

reading_time

Set true to show reading time for posts. And set words_per_minute, mine is 225.

logo

Your site’s logo. It will show on homepage and navigation menu. Also used for twitter meta tags.

background

Image for background. If you don’t set it, color will be used as a background.

MathJax

It’s enabled. But if you don’t want to use it. Set it false in _config.yml.

Third Party Services

You can set your username for third party services like matrix, github, etc. in _config.yml. If you don’t want to use one of them, just remove it or comment it out. If you add commento-url or umami to _config.yml, they will be used for comments and analytics.

To set what links appear in the top navigation edit _data/navigation.yml. Use the following format to set the URL and title for as many links as you’d like. External links will open in a new window.

- title: Home
  url: /

- title: Blog
  url: /blog/

- title: Projects
  url: /projects/

- title: About
  url: /about/

Layouts and Content

This theme uses Jekyll Compress to compress html output. But it can cause errors if you use “linenos” (line numbers). I suggest don’t use line numbers for codes, because it won’t look good with this theme, also i didn’t give a proper style for them. If you insist to use line numbers, just remove layout: compress string from layouts. It will disable compressing.

Feature Image

You can set feature image per post. Just add feature: some link to your post’s front matter.

feature: /assets/img/some-image.png
or
feaure: http://example.com/some-image.png

This also will be used for twitter card:

Twitter Card

project

Toot RSS Donate