2015-10-25 04:56:27 +01:00
|
|
|
# pelican-hyde
|
2015-10-25 05:48:47 +01:00
|
|
|
|
|
|
|
|
The pelican-hyde is a [Pelican](https://github.com/getpelican) theme inspired on the beautiful [Hyde](http://hyde.getpoole.com/) Jekyll theme
|
|
|
|
|
|
|
|
|
|
You can see a live demo [here](http://jvanz.github.io/)
|
2015-11-17 03:23:26 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2018-07-27 17:42:22 +02:00
|
|
|
|
|
|
|
|
Pull requests are welcome
|
2020-07-26 10:24:28 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Settings
|
|
|
|
|
|
|
|
|
|
List of Pelican's settings that are supported by this theme. Refer to the
|
|
|
|
|
[Pelican's documentation](https://docs.getpelican.com/en/stable/settings.html)
|
|
|
|
|
for more details.
|
|
|
|
|
|
|
|
|
|
- `FEED_*` and `*_FEED_*`
|
2020-08-07 05:32:05 +02:00
|
|
|
- `DEFAULT_PAGINATION`
|
2019-02-17 06:41:03 +01:00
|
|
|
- `DISPLAY_PAGES_ON_MENU`
|
2020-07-26 10:24:28 +02:00
|
|
|
- `DISQUS_SITENAME`
|
|
|
|
|
- `GOOGLE_ANALYTICS`
|
|
|
|
|
- `GA_COOKIE_DOMAIN`
|
|
|
|
|
- `SITESUBTITLE`
|
2019-02-17 06:41:03 +01:00
|
|
|
- `MENUITEMS`
|
|
|
|
|
- `SOCIAL`
|
2020-07-26 10:24:28 +02:00
|
|
|
|
|
|
|
|
Additional settings:
|
|
|
|
|
|
|
|
|
|
- `BIO` - short biography to display in the sidebar, eg. `Hello world`
|
|
|
|
|
- `PROFILE_IMAGE` - image to display in the sidebar, eg. `avatar.png`
|
2020-07-27 10:26:33 +02:00
|
|
|
- `FOOTER_TEXT` - footer to display in the sidebar, eg. `(C) 2020 Foo Bar`
|
2020-07-26 17:11:30 +02:00
|
|
|
- `COLOR_THEME` - base colors for the theme, choose from `08` to `0f`,
|
|
|
|
|
refer to <https://github.com/poole/hyde> for details.
|
Use Fork Awesome as the default icon font, and rework settings
In 16e3058, a FONT_AWESOME setting was introduced and used as such:
"https://kit.fontawesome.com/{{ FONT_AWESOME }}.js"
Also in 16e3058, the default way to fetch Font Awesome was changed to
Javascript (before we used to load is as CSS).
The present commit does several changes:
- Revert the default back to CSS (instead of JS), as I think that for a
font, there's no need for Javascript. A font is a static asset, so
it's enough to load it as a static CSS file, both for privacy and
security. Also, think about those who disable JS in their browser.
- Remove the `FONT_AWESOME` setting, as it's a bit too limiting to force
users into `kit.fontawesome.com`, it doesn't leave much space for
configuration.
- Instead, introduce two variables `FONT_AWESOME_CSS` and
`FONT_AWESOME_JS`, so that users have more freedom to define how they
want to load the Font Awesome.
- Use Fork Awesome as the default, if no setting is given by user.
Meaning that we get back to the `fa` css classes (instead of `fas` or
`fab`)
2020-07-26 10:57:40 +02:00
|
|
|
- `FONT_AWESOME_CSS` - URL to get Font Awesome as CSS
|
|
|
|
|
- `FONT_AWESOME_JS` - URL to get Font Awesome as Javascript
|
2020-07-26 11:13:58 +02:00
|
|
|
- `FONT_ACADEMICONS` - set to `True` to fetch the [Academicons font](https://jpswalsh.github.io/academicons/)
|
Use Fork Awesome as the default icon font, and rework settings
In 16e3058, a FONT_AWESOME setting was introduced and used as such:
"https://kit.fontawesome.com/{{ FONT_AWESOME }}.js"
Also in 16e3058, the default way to fetch Font Awesome was changed to
Javascript (before we used to load is as CSS).
The present commit does several changes:
- Revert the default back to CSS (instead of JS), as I think that for a
font, there's no need for Javascript. A font is a static asset, so
it's enough to load it as a static CSS file, both for privacy and
security. Also, think about those who disable JS in their browser.
- Remove the `FONT_AWESOME` setting, as it's a bit too limiting to force
users into `kit.fontawesome.com`, it doesn't leave much space for
configuration.
- Instead, introduce two variables `FONT_AWESOME_CSS` and
`FONT_AWESOME_JS`, so that users have more freedom to define how they
want to load the Font Awesome.
- Use Fork Awesome as the default, if no setting is given by user.
Meaning that we get back to the `fa` css classes (instead of `fas` or
`fab`)
2020-07-26 10:57:40 +02:00
|
|
|
|
|
|
|
|
By default, the theme uses **Fork Awesome**, which is fetched from
|
|
|
|
|
`cdn.jsdelivr.net`. Fork Awesome is a drop-in replacement for Font Awesome v4,
|
|
|
|
|
but is not compatible with Font Awesome v5 and later, so if you want to use
|
|
|
|
|
Font Awesome v5+, setting `FONT_AWESOME_CSS` is not enough, you will also need
|
|
|
|
|
to modify the templates.
|
2020-07-26 11:27:46 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Authors
|
|
|
|
|
|
|
|
|
|
- Original theme by [Mark Otto](https://github.com/mdo): <https://github.com/poole/hyde>
|
|
|
|
|
- Ported to Pelican by [José Guilherme Vanz](https://github.com/jvanz)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Released under the [MIT license](LICENSE)
|