Update README with info about the fork
This commit is contained in:
Baptiste Jonglez
parent
4ae7889570
commit
c62b4f50fb
65
README.md
65
README.md
|
|
@ -7,50 +7,47 @@ Zola Inky ([view demo](https://jimmyff.github.io/zola-inky)) is a theme by [jimm
|
|||
|
||||
[](https://jimmyff.github.io/zola-inky)
|
||||
|
||||
## Changelog
|
||||
## Changes compared to the original
|
||||
|
||||
For latest changes please see the [changelog](CHANGELOG.md).
|
||||
The main objective of the fork is to have no external dependencies (Google fonts, CDN...).
|
||||
It also adds flexibility.
|
||||
|
||||
## Features
|
||||
### Stop using Google fonts
|
||||
|
||||
- Responsive design
|
||||
- Responsive images
|
||||
- Gallery template
|
||||
- Taxonomy support
|
||||
- Search
|
||||
- Customisable via template hooks
|
||||
The required fonts are loaded locally from the theme itself.
|
||||
|
||||
## Getting started
|
||||
### Use fork-awesome for icons
|
||||
|
||||
1. Add this theme to your `themes/` folder (recommended method: git submodule).
|
||||
2. Copy of the the theme's config.toml file and put in your projects root directory. Update it as required and don't forget to add `theme = 'zola-inky'` at the top of the file.
|
||||
3. Copy this contents of the `content/` directory the root of your project and change the files as your necessary.
|
||||
Fork-awesome is used instead of feather, because it has more icons (e.g. a proper Mastodon icon).
|
||||
|
||||
## Customising the theme
|
||||
In addition, all icons are loaded locally from the theme itself.
|
||||
|
||||
- __To change the settings__ copy `config.toml` in to your project and update as required (make sure you add the theme variable at the top of the file, see the getting started heading above).
|
||||
- __To change the themes colours__ copy `sass/variables.scss` in to your project under the same folder and update as required.
|
||||
- __To inject content in to templates__ copy `templates/macros/hooks.html` and update as required.
|
||||
### Override footer content
|
||||
|
||||
## Using the responsive image shortcode
|
||||
You can override the content of the footer by overriding `base.html`.
|
||||
There are three blocks available:
|
||||
|
||||
Using the responsive images will make sure your images are generated at various sizes and served up to viewers at the size that best suits their device via the image srcset attribute. You can use this feature in your markdown like so:
|
||||
- `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)
|
||||
|
||||
```md
|
||||
{{ image(src="yourimage.jpg", alt="This is my image") }}
|
||||
Here is an example that you can put in `templates/base.html` in your website:
|
||||
|
||||
```html
|
||||
{% extends "zola-inky/templates/base.html" %}
|
||||
|
||||
{% block footer_center %}
|
||||
<a target="_blank" href="https://deuxfleurs.fr/"><img src="deuxfleurs_en.png" alt="Badge showing the website is hosted by Deuxfleurs" title="Website hosted by Deuxfleurs"></a>
|
||||
{% endblock footer_center %}
|
||||
|
||||
{% 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 %}
|
||||
```
|
||||
|
||||
## Feature requests & support
|
||||
### Styling for tables
|
||||
|
||||
I'm afraid I'm unable to accept feature requests or provide user support for this theme. The [Zola documentation](https://www.getzola.org/documentation/getting-started/overview/) and [Tera documentation](https://tera.netlify.app/docs/) are great resources and there is a [Zola discussion forum](https://zola.discourse.group/). If you've found a bug in the themse please open a github issue.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are very welcome! If you are planning to add a feature to the theme then feel free to open an issue to discuss your approach and we will be able to say if it's it will likely be accepted. Please keep the following in mind:
|
||||
|
||||
- Only widely generic features will be accepted, anything too specific should be kept to your own templates.
|
||||
- Be careful about destroying indentation as Tera syntax doesn't seem to be widely supported by IDEs.
|
||||
- Keep it lean. Adding bloat will likely result in your PR being rejected.
|
||||
- Consider backward compatibility, ideally people blindly-upgrading won't see any unexpected changes to their sites.
|
||||
|
||||
New theme maintainers are welcome but should provide pull-request or two first!
|
||||
See <https://blog.bitsofnetworks.org/riscv-performance-power-usage/>
|
||||
|
|
|
|||
Loading…
Reference in a new issue