~fd/grav-theme-ersei2

Theme for ersei.net

Ersei Saggi via public-inbox

a month ago
2 months ago

#Ersei 2 Electric Boogaloo

Ersei 2 is a theme for Grav CMS that prioritizes speed and simplicity. It does not require (nor does it include) any Javascript and it keeps styles to a bare minimum. This ensures a fast, consistent user experience across browsers and devices.

Based off of the Hypertext theme.

You can see it live here.

Why does this theme exist? Most Grav themes come with heavy JS requirements. Sometimes 1MB or more! These slow down browsers and create compatibility issues. Grav is a very powerful CMS but there should be an option for people who want something as close to hand-coded HTML as possible. This theme tries to separate form and function to create a truly unique experience. It even works in windows 95!

#Features

  • Virtually weightless for maximum performance
  • CSS/JS squelches to completely cut out any unnecessary stuff
  • Fully responsive across almost any device
  • Includes headless parameter for serving only content
  • HTML 3 & HTML 5 compliance modes
  • Hyperlegible override for visually impaired users
  • 25 built-in, open source stylesheets

#Supported Page Templates

  • Default view template default.md
  • Error view template error.md
  • Directory view template collection.md
  • Blog view template blog.md and blog_list.md
  • Blog item view template item.md and blog_item.md

#Installation

Installing the theme can be done in one of two ways. Grav's GPM (Grav Package Manager) installation method enables you to quickly and easily install the theme with a simple terminal command, while the manual method enables you to do so via a zip file.

#Manual Installation

To install this theme, just download the zip version of this repository and unzip it under /your/site/grav/user/themes. Then, rename the folder to ersei2. You can find these files on Sourcehut.

You should now have all the theme files under

/your/site/grav/user/themes/ersei2

NOTE: This theme is a modular component for Grav which requires the Grav, Error and Problems plugins.

#Updating

As development for the ersei2 theme continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating ersei2 is easy, and can be done through Grav's GPM system, as well as manually.

#Manual Update

Manually updating ersei2 is pretty simple. Here is what you will need to do to get this done:

  • Delete the your/site/user/themes/ersei2 directory.
  • Download the new version of the ersei2 theme from Sourcehut.
  • Unzip the zip file in your/site/user/themes and rename the resulting folder to ersei2.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing bin/grav clear-cache.

Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in user/config/themes) will remain intact.

#Dependencies

This erse2 theme runs on the latest version(s) of Grav CMS, namely 1.6 or higher.

#Setup

If you want to set ersei2 as the default theme, you can do so by following these steps:

  • Navigate to /your/site/grav/user/config.
  • Open the system.yaml file.
  • Change the theme: setting to theme: ersei2.
  • Save your changes.
  • Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in Terminal and typing bin/grav clear-cache.

Once this is done, you should be able to see the new theme 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 ersei2 folder.