GitHub Pages-Starter Pack

Reading time ~9 minutes

TOC:

Github makes it easy to get started, with the click of a button, you can have a web-page live, requiring only markdown skills (that anyone can learn on the go).

Each feature you want to enable requires a little more learning, and GitHub Pages is set up so that if you decide to, you can gradually progress from content creator to web-developer.

If you don’t want to think about web-development, and simply want your markdown files to look beautiful once published, github pages can help you do that too.

I first started playing around with GitHub to make an awesome-list, in November.

The number of technical subjects I’ve begun to learn, thanks to github, is incredible. Publishing via github-pages is really empowering.

Introduction

I’m just a newb that created this resource to help myself. It does take a lot of work to create bigger projects like, however it’s really simple to create a blog, or a homepage.

Corrections, suggestions, tips, and links would be all appreciated.

Github pages runs Jekyll, which uses Kramdown to transform yaml, markdown, and a number of related languages into proper html.

Getting Started

The simplest way to use pages is to choose one of the official GitHub pages themes. Just go into your repository settings:

All you really need to do is select a branch and it will begin publishing your repository. Then choose a method to publish. Brand-newbs go with the theme chooser.

The first repository for your web-page must be named like so: username.github.io. For example, the repository for my personal page is called infominer33.github.io. Simply create a new repository, and if your github username is @awesomesauce then you would create a new directory named awesomesauce.github.io.

Every other repository you own can also be made into its own web-page, that will published off of your user page, with the same name following your domain. So if you have a repository called, /Dynomite and you go into settings select pages to publish from the master branch, then that page will be found at https://awesomesauce.github.io/Dynomite.

so github.com/didecentral/didecentral.github.io is published at decentralized-id.com, because I have a custom domain. But it can still be found at, infominer33.github.io/DIDecentralized.

Domains

Namecheap supports BTC purchases, so I’m including their github how-to here. If you know of other crypto-friendly domain providers, lmk in the issues.

Besides the Theme Chooser

It’s time for an update, since I previously didn’t really understand all of the options very well.

There are a few ways to use GitHub Pages. How many?

I’ll list the ones that I can think of:

Gem Based Themes

Gem files are packages that contain all of the files necessary for building your site, and keep your repository directory un-cluttered. Then, if you want to change a file that’s in the gem, you just create the directory and pur the file where it goes, and configure as you wish.

  • planetjekyll/awesome-jekyll-themes

    Q: How can I get started with gem-packaged themes? / Do I need to package my theme into a gem?

    Gem-packaged themes are just an advanced option and in addition they are in development for (real world) experiments (e.g. think v0.1 as stated by the Ben Balter - the lead designer / manager / dev at GitHub).

    Thus, to conclude do NOT read too much into the official themes docs e.g. as the only or “right” way to design a theme. Just (continue to) use “classic” themes - there are hundreds to learn from and once you have mastered “classic” themes you can “graduate” to the master class, that is, using gem-packaged themes.

GitHub Supported

GitHub Pages Supports the following gem themes:

  • Architect
  • Cayman
  • Dinky
  • Hacker
  • Leap day
  • Merlot
  • Midnight
  • Minima
  • Minimal
  • Modernist
  • Slate
  • Tactile
  • Time machine

Everything Else

You can use any gem based theme that you want. However, GitHub won’t build those for you.

You must build them locally, and tell jekyll to build to the docs directory, which you may have noticed as an option in your repository settings, and github will publish that directory. However, for user or organization pages, you can only publish from the master directory.

So this will only work for projects other than your homepage, or your organizations homepage.

Simply add the following line to your _config.yml

destination: docs

Then add the gem and the source, also add any plugins you are using, such as in this example:

source 'https://rubygems.org'
gem "minimal-mistakes-jekyll"

gem "jekyll-paginate"
gem "jekyll-sitemap"
gem "jekyll-gist"
gem "jekyll-feed"
gem "jemoji"
gem "jekyll-include-cache"

then from the root of your project directory, on your local command-line:

bundle install bundle exec jekyll serve

And you can view your updates to the project locally, before sending them over to github.

Even if you don’t use this install method, you should use the same steps to build locally, regardless.

Remote Themes

This makes it simpler to keep your source files up to date. However, it is slower than using gems to build locally

   plugins:
     - jekyll-remote-theme

   remote_theme: benbalter/retlab

Essentially, if you’re just editing files on github, you should just add those lines to your _config.yml along w an index file and Jekyll should build your site.

Classic Themes

These classic themes are just files and folders, everything where you can see it (and should be forkable to create working websites).

Github Pages

Jekyll

Jekyll Themes

I’ll say now, if you are new to web-development, best to start off trying out a few of the official GitHub Pages Themes.

Once installed, I cloned those repos locally so its easier to see how everything works. Then, if I want to configure a file that’s not in my repository, I have a copy nearby. You can grab the _layouts/default.html, put it in your repo, and get a feel for how configuring that template shapes your entire site. But then you configure individual pages, and categories, perhaphs, to display differently.

Finding Themes

The problem is that all of these websites are not exactly up to date. Many of the themes listed above were written for older versions of Jekyll.

Choosing a theme is very personal to your needs, also.

Found Themes

I’m keeping track of themes that catch my eye:

Hydejack

If you don’t want to think too much about web-development, try Hydejack. It’s build with everything you need to create a beatiful responsive web-page, with plenty of options and configurations supported. It’s a free version of a more robust commercial option. But it’s easy to set up, and works great.

The only problem is that it is not open source. So it’s not 100% customizable. Then again, that keeps you from getting in and screwing things up. –>

Minimal Mistakes

Minimal Mistakes is the most popular theme for Github Pages, and with good cause. It creates gorgeous web-sites right out the box, and with some fine tuning is beautiful indeed. You can find pretty much everything you need to run Minimal Mistakes in the Quickstart Guide, Sample Posts and Collections, along with their corresponding files on Github.

Other themes by @mmistakes:

I’ve just listed what repositories most fit my use cases, you might want to browse through his github portfolio, yourself.

Made Mistakes

So Simple

Basically Basic

Skinny Bones

Hpstr

This site currently runs on Hpstr, but it is archived, and doesn’t support modern features of jekyll such as baseurl, nor can I get jekyll-redirect-from to work with it.

I will try migrating this to the Hugo port of this theme, which i believe is maintained. It’s been nice trying out though, and I’ve got a few I’d like to look at anyway.

Setup

Create an index.md

Although pages will build an index.html from your readme.md, pages will not behave as expected if you try to do any configuration or additional optimization with only readme.md.

in that index.md you need to include front matter:

---
layout: default
---

There is a plugin that builds index files from all the readme.md files of your repository.. but it has trouble creating an index.html from your repositories primary README.md.

Front Matter

Layouts

Layouts are preconfigured page templates. When I started, it was too much to think about layouts, and I would use “single” and “page”. Now that I am using blog posts.. (because they populate your RSS feed, and increases their portability) I’m also using the Home layout:

I’m wondering if I can move these documentation theme layouts, or even this post index from hpstr over to minimal-mistakes… probably so… except maybe there is custom css.. and I really haven’t taken the time to figure that out, yet.

Collections

Plugins

Use redirect_from: internal/url to change the location you are publishing, but keep old links. Use redirect_to: https://external.url to send visitors somewhere else (perhaps you want it to live on another site, but not lose your valuable links :)

Mining, Exploring, Exporting: Creating Content with CSV Tweet Histories

Export your tweets to CSV, filter in a spreadsheet and publish. Continue reading

Hugo Starter Kit

Published on June 07, 2019