Skip to content
This repository has been archived by the owner on Apr 27, 2024. It is now read-only.

Latest commit

 

History

History
73 lines (55 loc) · 2.39 KB

index.md

File metadata and controls

73 lines (55 loc) · 2.39 KB
layout
page

Oatcake

This is Oatcake, the GitHub Pages theme that I use on seanh.cc. It's meant to be a plain theme, fast and mobile friendly, that doesn't get in the way of reading or writing. It has a simple layout and uninteresting colours and fonts.

The theme has nice basic typography and lots of typographical extras like figures, code highlighting, <kbd> and <samp> styling, footnotes, emoji, alerts, subtitles, badges and more.

It also has convenient links for creating and editing pages and supports drafts even on GitHub Pages.

See the posts for the full list of features.

Using with GitHub Pages

  1. Add the theme to your _config.yml file with the remote_theme setting, and also add the jekyll-feed plugin that the theme needs:

    remote_theme: seanh/[email protected]
    plugins:
    - jekyll-feed
    You'll want to change the `@0.1.3` part at the end of the theme name to the [the latest version of the theme]({{ site.github.repository_url }}/releases).

    When new versions of the theme are released you update this theme version number in your _config.yml file, commit it, and push it to GitHub, and GitHub pages will rebuild your site with the new version of the theme.

    See jekyll-remote-theme for more about how GitHub Pages handles GitHub-hosted Jekyll themes.

  2. Include the list of blog posts in a page somewhere, by using this include:

    {% raw %}{% include post_list.html %}{% endraw %}

    For example you might want to include it on your front page, or on a /posts page.

Posts

{% include post_list.html %}

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/seanh/jekyll-theme-oatcake/.