fbievan
/
hugo-theme-readable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
11 Commits 3 Branches 0 Tags 620 KiB
CSS 50.9%
HTML 38.1%
XSLT 11%
Go to file
Robert Lützner 473add39bd
feat: load favicon if configured via params.favicon (#5) 
This will display a favicon for the website. Favicons are cute little
icons that will show up on tabs in your browser, e.g. GitHub's mascot.
They can easily be generated by using online tools, e.g.

https://realfavicongenerator.net/

The resulting package only has to be downloaded and extracted into the
'static' directory of a Hugo website that is using this theme.

The path can then be set as follows in the config.yml:

```yaml
params:
  favicon: favicon.ico
```

This fixes #3.

Co-authored-by: Robert Lützner <robert.luetzner@iternity.com>
 		2023-02-22 12:59:35 -06:00
archetypes old work pushed 2023-01-30 13:14:33 -06:00
docs updated documentation 2023-02-13 13:25:06 -06:00
layouts feat: load favicon if configured via params.favicon (#5) 2023-02-22 12:59:35 -06:00
static/css feat: update to v1.0.1 2023-02-16 13:51:44 -06:00
LICENSE old work pushed 2023-01-30 13:14:33 -06:00
README.md quick README typo fixes 2023-02-13 13:26:04 -06:00
theme.toml old work pushed 2023-01-30 13:14:33 -06:00

README.md

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.

Want to check out a demo? (coming soon)

demo image

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://github.com/cjtheham/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'

If you don't have an existing site, feel free to use the provided starter template to quickly get your website online.

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.

Notes

  • Benjamin loves when new sites and projects pop up using the readable.css framework!