Switch branches/tags
Nothing to show
Find file History
Latest commit 281089f Nov 24, 2017
Permalink
..
Failed to load latest commit information.
static Add Graymill theme Aug 4, 2017
templates Fixed 'pages' variable Nov 24, 2017
LICENSE Add Graymill theme Aug 4, 2017
README.md Add Graymill theme Aug 4, 2017
sample_pelicanconf.py Add Graymill theme Aug 4, 2017

README.md

Graymill - A minimal Pelican theme.

Graymill is a minimal, responsive theme for the Pelican static site generator. It is based on the Milligram CSS framework.

Demo

See the theme in action at muchBits

Features

  • Syntax highlighting for code blocks
  • Easy to install
  • Minimal/No Javascript (JS is only used in case Google Analytics is enabled).
  • Google Analytics Support
  • Responsive (Mobile Friendly Test on Google)

Installation

  • Clone the repository:
git clone https://github.com/rn4ir/graymill.git
  • Create a THEME variable in your pelicanconf.py file and set its value to the location of graymill theme, like so:
THEME = 'path/to/graymill'

Custom Variables

(Please refer to the sample pelicanconf.py contained in this repo for examples)

The Graymill theme use the following settings in the pelicanconf.py:

pelicanconf.py

Social Icons:

SOCIAL = (('linkedin', 'https://www.linkedin.com/in/username'),
          ('github', 'https://github.com/username'),
          ('twitter', 'https://twitter.com/username'),
          ('facebook', 'https://facebook.com/userid'),
          )

Pagination:

DEFAULT_PAGINATION = 8

Home page parameters:

SITEDESCRIPTION = 'your-site's-tagline'
DISPLAY_SUMMARY = True
DISPLAY_PAGES_ON_MENU = True

Other Settings

FAVICON = 'images/favicon.png'
STATIC_PATHS = ['images', 'extras']
EXTRA_PATH_METADATA = {
    'extras/.htaccess': {'path': '.htaccess'},
    'extras/robots.txt': {'path': 'robots.txt'},

For local development:

SITEURL = 'http://localhost:8000'

publishconf.py

When you are ready to publish your site add the following settings to publishconf.py file

SITEURL = 'https://domain-name.tld'

FEED_ALL_ATOM = 'feeds/all.atom.xml'
CATEGORY_FEED_ATOM = 'feeds/%s.atom.xml'

GOOGLE_ANALYTICS = ""

For more information on publishing your site, please read the Pelican publishing docs