A simple and elegant theme for pelican
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Felix 03995ce87c Release version 1.4, remove solarized styles 1 year ago
static Release version 1.4, remove solarized styles 1 year ago
templates Release version 1.4, remove solarized styles 1 year ago
.gitignore gitignore 2 years ago
README.md Release version 1.4, remove solarized styles 1 year ago
mockup.jpeg Update theme mockup 1 year ago

README.md

Sleek Tern Theme for Pelican

A clean, elegant and simple theme for the Pelican static site generator. Fully responsive, solarized pygments. Feeds support.

Download the latest stable release from git.ix5.org.

The theme in action

Features

  • Easy on the eyes, subtle and tastefully elegant
  • Responsive, with a print stylesheet
  • MIT-licensed
  • Pelican version 3.7 ready
  • Smart link underlines
  • Pygments with solarized theme
  • MENUITEMS support to customize navbar
  • Support for embedding isso commenting system
  • Plugin support:
    • post_stats Display word count and estimated reading time of articles
    • series Publish multi-part articles. The first page in the series displays an overview of all articles in that series, subsequent ones have next and previous links at the bottom
    • tagcloud Draw a tag cloud with varying sizes

Instructions

The following variables should be set to utilize all features of the theme:

  • SITETUBTITLE for a short byline
  • CUSTOM_HEADER_BOX to use a custom logo instead of site title and subtitle
  • SITEDESCRIPTION to set a short(~160 characters) <meta desc>
  • DIRECT_TEMPLATES = ['tagcloud', 'index', 'categories', 'archives', 'tags']
  • SUBFOLDER_NAME to name the ‘Home’ link differently, e.g. if your pelican site lives at example.com/blog/, set it to ‘Blog’

Theme defaults

  • DISPLAY_FOOTER = True Display a footer with pelican credits and links to feeds
  • ARTICLE_STATS_IN_ARCHIVES = False Display word count and estimated reading time in archives
  • FAVICON = dict(url='path_to/favicon.ico', type='image/ico') Set a favicon, must be a dict
  • DISPLAY_CATEGORY_IN_POST = True Show category link at the bottom of articles
  • DISPLAY_TAGS = True Display tags at the end of an article

Recommendations

  • PAGINATION_PATTERNS, else the theme has to fall back on .html links
  • TYPOGRIFY = True for better typography with typogrify (smart quotes, ... etc.)
  • AUTHOR_SAVE_AS = '' if there is only one author
  • *_SAVE_AS for prettier URLs
  • DISPLAY_PAGES_ON_MENU = False if you have too many pages to fit into the navbar
  • In order for pelican to print out dates using English text, set LOCALE and DATE_FORMATS, see Time and Date
  • Concerning the series plugin:
    • The first page in the series displays an overview of all articles in that series, subsequent ones have next and previous links at the bottom and a small hint that they belong to a series
    • The series plugin does not work well with translations. The theme will not crash, but will disable certain features
  • Concerning the isso commenting system feature, put something like this in your publishconf.py:

    # Isso commenting system
    ISSO_SITEURL = 'https://example.com/isso'
    # ISSO_SETTINGS is needed
    ISSO_SETTINGS = {
        'css': 'true',
        'lang': 'en',
        'vote': 'false',
        'avatar': 'true',
        'require-author': 'true',
        'reply-to-self': 'true',
        'js-embed-url': '%s/js/embed.min.js' % ISSO_SITEURL
    }
    

Contributors

Name

The Arctic tern (Sterna paradisaea) is a seabird of the tern family Sternidae.
Since this theme descends from numerous other projects named after birds (Pelican, Mockingbird, Penguin), the name reflects its heritage but also its sleek nature.

License

  • Theme: MIT(see below)
  • Solarized colors: MIT, by Ethan Schoonover
  • CSS: MIT
  • Typefaces: SIL OFL 1.1

The MIT License (MIT)

Copyright © 2018 Felix Elsner et al.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.