Utterson
Utterson is a port of Hyde (the Jekyll theme) for Pelican.
What's in a name?
This theme was named Utterson to follow the Jekyll-Hyde convention. Gabriel John Utterson is the main protagonist and a loyal friend of Jekyll in the Strange Case of Dr Jekyll and Mr Hyde.
Live preview
You can see how this theme looks like at https://www.vinayakmehta.com.
Screenshot
Desktop
Phone
Usage
To use Utterson, clone this repo and add the absolute/relative path to the cloned folder in the THEME variable of your pelicanconf.py.
THEME = '/path/to/utterson'
Utterson supports all Hyde features in addition to its own.
You can define the following variables in your pelicanconf.py to use the corresponding features.
| Variable | Feature |
|---|---|
| TITLE | Adds website and sidebar title. |
| DESCRIPTION_SIDEBAR | Adds sidebar description. |
| MENUITEMS | Adds sidebar menu items. For example:
MENUITEMS = [
('About' , '/about' ),
('Archive' , '/archive.html')]
|
| SOCIAL | Adds sidebar social links using Font Awesome (follows tuple order). The brand name is appended to Font Awesome's fa-. For example: github will become fa-github.
SOCIAL = (
('github' , '<github_url>'),
('twitter' , '<twitter_url>'),)
|
| GITHUB_URL | Adds GitHub Corner to website. |
| TWITTER_USERNAME | Adds a Tweet button on an article's page. |
| DISQUS_SITENAME | Adds Disqus comments on an article's page. |
| TINYLETTER_USERNAME | Adds TinyLetter link to sidebar. You would also need to specify the newsletter name using TINYLETTER_NEWSLETTER. |
Supported Plugins
Contributing
Please open an issue to discuss the bug/feature before submitting a PR.
Be cordial or be on your way. –Kenneth Reitz
Versioning
Utterson uses Semantic Versioning. For the available versions, see the tags on this repository.
License
This project is licensed under the MIT License, see the LICENSE file for details.