Skip to content

Contents

Jump to bottom
Juliano Fernandes edited this page Mar 8, 2024 · 1 revision

jekyll-theme-8bit has been scaffolded by the jekyll new-theme command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.

Layouts

Refers to files within the _layouts directory, that define the markup for your theme.

  • default.html — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says {{ content }} and are linked to this file via FrontMatter declaration layout: default.
  • post.html — The layout for your posts.

Includes

Refers to snippets of code within the _includes directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.

  • downloads.html — Insert download buttons when using the theme on a project with GitHub Pages enabled and the show_downloads variable set to true in _config.yml.
  • footer.html — Defines the site's footer section.
  • fork-me.html — Shows a "Fork me on GitHub" link when using the theme on a project with GitHub Pages enabled.
  • google-analytics.html — Inserts Google Analytics module (active only in production environment).
  • head.html — Code-block that defines the <head></head> in default layout.
  • header.html — Defines the site's main header section. By default, pages with a defined title attribute will have links displayed here.
  • social.html — Icons for social networks. Wich icons will be visible depends on what was defined in _config.yml.

SASS

Refers to .scss files within the _sass directory that define the theme's styles.

  • fonts.scss — Defines font faces used by 8bit's theme.
  • jekyll-theme-8bit.scss — The core file imported by preprocessed assets/css/style.scss, it defines the defaults for the theme, layout, etc, and also further imports sass partials to supplement itself.
  • rouge-github.scss — Defines the styles for syntax-highlighting.

Assets

Refers to various asset files within the assets directory.

  • css/style.scss — Imports sass files from within the _sass directory. It is what gets processed into the theme's main stylesheet main.css called by _layouts/default.html via _includes/head.html.
  • fonts/Press-Start-2P/ — The directory contains font files for ttf, woff and woff2 formats.
  • js/scale-fix.js — Zooming scale fix for iPhone.

This directory can include sub-directories to manage assets of similar type (img, fonts, svg), and will be copied over as is, to the final transformed site directory.

Plugins

jekyll-theme-8bit comes with two plugins preinstalled.

  • jekyll-paginate — Allows break the main listing of posts up into smaller lists and display them over multiple pages. See documentation for more details.
  • jekyll-seo-tag — Ensure your website gets the most useful meta tags. See usage to know how to set it up.
Clone this wiki locally