Skip to content

Latest commit

 

History

History
164 lines (107 loc) · 8.25 KB

README.md

File metadata and controls

164 lines (107 loc) · 8.25 KB
Raw

Hereditor Skeleton

Hereditor Preview

About

Background

The Hereditor theme for Grav is a detached fork of the Mediator theme developed by Grav Team and contributors, which was a port of the Mediator theme for Jekyll designed by Dirk Fabisch, which in turn was inspired by the Readium theme for Ghost elaborated by Sven Read.

Downloads

You can download the Hereditor theme individually on its own repository but it might be better to download the full Hereditor skeleton.

References

You can find out more info about customizing a Grav theme (as well as basic usage documentation on the official Grav Documentation) and check the full source code on GitHub.

License

The Hereditor theme is free and open source software, distributed under the MIT License version 2 or later. So feel free to to modify this theme to suit your needs.

Overview

Features

  • Minimal design
  • Responsive layout
  • Header images in posted articles
  • Support of featured posted articles
  • Implementation of Font Awesome for icons fonts use
  • Integration of free and open source improved fonts (WOFF 2.0)

Supported page types

The Hereditor theme was mainly conceived to craft a simple blog and supports four distinct page types via templates:

  • default: a template used to display the default blog listing view
  • error: a very simple template to display an error page
  • post: a full page for displaying a blog post
  • page: similar to the post template, but without any author information

Embedded assets

  • Font Awesome (version 4.7.0, font file licensed under the SIL OFL 1.1 and CSS file licensed under the MIT License), is a suite of (...) pictographic icons for easy scalable vector graphics on websites, created and maintained by Dave Gandy
  • Inter (version 3.19, © The Inter Project Authors, licensed under the SIL Open Font License 1.1), is a variable font with several OpenType features which has been crafted & designed for computer screens ("Inter" is trademark of Rasmus Andersson)
  • Libertinus Fonts (version 7.040, © The Libertinus Project Authors, released under the terms of the Open Font License, version 1.1, with Reserved Font Name "Linux Libertine", "Biolinum", "STIX Fonts"), is a typeface project which includes four main type families which were originally forked from Linux Libertine (only four files for two weights --Regular and Bold-- in two styles --Regular, Italic-- of the Serif family are embedded in the theme)
  • normalize.css (version 8.0.1, © Nicolas Gallagher and Jonathan Neal released under MIT License) is a small CSS file which aims to render (...) elements more consistently (...) with modern standards (and) precisely targets only the styles that need normalizing

Additional pictures

Additional pictures used to craft the Hereditor skeleton package belong to their original authors according to the Unsplash licence. The list below provides precise attributions:

Using the skeleton

The simplest way to install the Hereditor theme is to download and install the Hereditor skeleton package:

  1. Download the Hereditor skeleton
  2. Unzip the package into your web root folder.
  3. Point your browser at the folder.

Check out the general Grav installation instructions for more details on this process.

It is possible to install just the theme as described below, but page content will need to fit the templates supported the Hereditor theme. It is strongly advised to at least install the Hereditor skeleton package as described above to see the structuration of the theme in action.

Setup

Theme activation

To set the Hereditor theme as the default theme, the steps to follow are:

  • Navigate to /your/site/grav/user/config
  • Open the system.yaml file
  • Change the theme: setting to theme: hereditor
  • Save the changes
  • Clear the Grav cache using admin panel or following command:
bin/grav clear-cache

Once this is done, the new theme should be available on the frontend. Keep in mind any customizations made to the previous theme will not be reflected as all of the theme and templating information is now being pulled from the hereditor folder.

Site parameters

In case the Hereditor theme is activated on a fresh Grav install, some parameters in the user/config/site.yaml file have to be populated:

  1. title: name of your site
  2. description: description of your site
  3. author.name: name site owner
  4. author.email: mail address of the site owner
  5. author.bio: short one sentence biography

The file should look a bit like this:

title: Website name
description: A short description for the purpose of the website
author:
  name: Author Name
  email: username@domain.tdl
  bio: A short description of the author of the website

Custom styles for plugins

The Hereditor theme includes custom styles for specific plugins (Markdown Notices, Pagination). To be properly loaded, the Use built in CSS option has to be set to false (using the admin panel or configuring the YAML file in the users/config/plugins/ folder):

built_in_css: false

Configuring images and links

Website images

Basically, the Hereditor theme is arranged to use two images for the entire website:

  1. logo: used into default page and to link toward the home page (but also as basic shortcut icon). This image aims to represent the website and should not exceed a size close to 300px × 300px.
  2. author.image: set as illustration in the mini-bio. This image aims to represent the author of an article and should not exceed a size close to 300px × 300px.

These two images have to be defined in your /your/site/grav/user/config/site.yaml file, such as:

logo: /user/images/logo.png
author:
  image: /user/images/avatar.png

Article header images

Header images can be used in articles which are based on the post template. Any header image has to be declared in the front-matter section of the post, by adding a tag image populated with a proper URL to the intented file, such as this code sample (if the image is set in the same folder as the article):

image: header-image.jpg

Social links

In order to set social profiles features to be embedded in the Hereditor theme configuration, add the following to your /your/site/grav/user/config/site.yaml file:

  1. social.icon: name of the social platform
  2. social.link: the main URL of the plateform
  3. social.user: the specific user name on the plateform

Below is an example for a Twitter account:

social:
  - icon: twitter
    link: https://twitter.com/
    user: username