Skip to content
This repository has been archived by the owner on May 19, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (45 loc) · 2.27 KB

README.md

File metadata and controls

55 lines (45 loc) · 2.27 KB
Raw

pelican-neat

A neat and flexible pelican theme based on the personal blog theme of Berker Peksag.

Preview

  • Index: index screenshot
  • Article: article screenshot
  • Article Scrolled: index screenshot

Configuration Options

  • SITE_SOURCE (URL) - URL to site's source if exists
  • SITE_TAGLINE (multi-line string) - Tagline for the site
  • SITE_ICON (URL) - URL for the site's favicon. (can be a data URL)
  • PRINT (boolean) - Set to True to enable a print link in pages.
  • AUTHOR_SHORTBIO (multi-line string) - Info about the author to be displayed on footer.
  • AUTHOR_EMAIL (email) - E-mail address of the author to be displayed on the pages.
  • AUTHOR_EMAIL_HASH (string) - The md5 hash of the author e-mail to fetch his/her avatar from Gravatar. Recommended value is md5(AUTHOR_EMAIL).hexdigest() with from hashlib import md5
  • TWITTER_USERNAME (string) - Twitter username of the auther to be used in various places such as share referrals and bio section.
  • GITHUB_USERNAME (string) - GitHub username of the author to be used in various places such as the bio section and the GitHub Badge if enabled.
  • GITHUB_BADGE (boolean) - Set to True if you want to display the badge for your GITHUB_USERNAME in the bottom right corner of the pages.

Who's Using Neat

License

All files that are part of this project are covered by the following license, except where explicitly noted.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.