hugo-theme-readable

Readable is a theme for the static-site generator Hugo using the readable.css framework built by Freedom to Write.

Shoutout to Benjamin Hollon for his amazing work building this CSS framework and making it so simple to use.

This is a fork of the project hugo-theme-readable https://codeberg.org/Freedom-to-Write/hugo-theme-readable

Installation

To add this theme to an existing Hugo site, start by adding this repo as a submodule in the site's themes folder.

git submodule add https://git.fbievan.live/fbievan/hugo-theme-readable themes/readable

Then, update your config file to be using the new theme. For example, if you are using config.toml, the line should become:

theme = 'readable'

For more information on starting a Hugo website and using custom themes, refer to the Hugo documentation.

Usage

Freedom to Write has provided some awesome guides on writing HTML that works automatically with the formatting of Readable. For a complete HTML page guide on writing custom pages, see Overall Structure. For some neat tips that may make life easier working with this style sheet, read Quick Tips.

The rest

As mentioned, This is a fork of hugo-theme-readable, and will continue to cherry-pick commits from the upstream. I also commit to pushing certain things I think work with the upstream project, to the upstream.

This is very much a opinonized theme for my site, and you can use it for yours, I however ask that you credit me as I credit Benjamin, and CJ for the work done on this project.

Without Benjamin Hollon or C.J this theme wouldn't exist.

Projects used:

• hugo created by Bep
• Readable.css created by Benjamin Hollon
• Hugo Readable Theme created by C.J