zola-inky-fork/README.md

54 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2023-02-01 17:58:59 +00:00
# Zola-Inky
> An elegant and understated theme for Zola
2023-02-02 10:40:59 +00:00
Zola Inky ([view demo](https://jimmyff.github.io/zola-inky)) is a theme by [jimmyff](https://github.com/jimmyff) and [mr-karan](https://github.com/mr-karan) for the [Zola](https://www.getzola.org/) static site generator. This theme was originally based on the [hugo-ink](https://github.com/knadh/hugo-ink) theme, ported by mr-karan. It was then packaged and developed further by jimmyff. The theme is available on [Github](https://github.com/jimmyff/zola-inky) under the MIT license, for more information on how to use it please see the [readme](https://github.com/jimmyff/zola-inky/blob/main/README.md) and check the [changelog](https://github.com/jimmyff/zola-inky/blob/main/CHANGELOG.md) for a list of the latest changes.
2023-02-01 17:58:59 +00:00
[![PNG](screenshot.png)](https://jimmyff.github.io/zola-inky)
2023-12-09 15:30:12 +00:00
## Changes compared to the original
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
The main objective of the fork is to have no external dependencies (Google fonts, CDN...).
It also adds flexibility.
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
### Stop using Google fonts
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
The required fonts are loaded locally from the theme itself.
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
### Use fork-awesome for icons
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
Fork-awesome is used instead of feather, because it has more icons (e.g. a proper Mastodon icon).
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
In addition, all icons are loaded locally from the theme itself.
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
### Override footer content
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
You can override the content of the footer by overriding `base.html`.
There are three blocks available:
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
- `footer_left`: contains social and RSS buttons by default
- `footer_center`: empty by default
- `footer_right`: contains attributions by default (please keep the link to the original theme author)
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
Here is an example that you can put in `templates/base.html` in your website:
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
```html
{% extends "zola-inky/templates/base.html" %}
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
{% block footer_center %}
2023-12-09 15:38:04 +00:00
<a target="_blank" href="https://deuxfleurs.fr/"><img src="{{ get_url(path='deuxfleurs_en.png') }}" alt="Badge showing the website is hosted by Deuxfleurs" title="Website hosted by Deuxfleurs"></a>
2023-12-09 15:30:12 +00:00
{% endblock footer_center %}
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
{% block footer_right %}
Licence: CC-BY-SA {{ config.title }} {{ now() | date(format="%Y") }}
<br>
Powered by <a target="_blank" href="https://getzola.org/">Zola</a>.
Theme: <a target="_blank" href="https://github.com/jimmyff/zola-inky">Inky</a> (<a href="https://git.deuxfleurs.fr/baptiste/zola-inky-fork">fork</a>).
{% endblock footer_right %}
```
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
### Styling for tables
2023-02-01 17:58:59 +00:00
2023-12-09 15:30:12 +00:00
See <https://blog.bitsofnetworks.org/riscv-performance-power-usage/>