A theme for my pelican-powered blog.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
static
templates
.gitignore
README.md
index.js
package.json

README.md

feltnerm-pelican-theme

This the front-end module of my Pelican-powered blog.

Getting Started

To use, set your pelican theme to this theme. A few of (my current) methods for accomplishing this are:

npm

% npm install --save feltnerm-pelican-theme

Iff ./node_modules is a direct child of your Pelican working-directory, then in pelicanconf.py you add/modify the following:

THEME = 'node_modules/feltnerm-pelican-theme'

Layout

CSS

Normalize is used (as it should), Typset is used for typographic things such as post bodies, and flexboxgrid is a simple wrapper for grid-based layouts using flexbox (sorry <=IE10 users).

JavaScript

  • Sources: ./src/js
  • Bundle Destination: ./build/bundle.js
  • Dependencies:

Templates

Templates are written using Jinja and follow the pelican template conventions. They are 'compiled' with pelican. See the pelican theme documentation for more details.

Templates should follow semantic HTML5 (header, footer, nav, article, aside, section, etc.), and attempt to follow the microdata HTML5 standard as best as possible.

I am not entirely sure of the benefits of microdata in HTML documents yet, but consider this an experiment. Part of me wonders if it'd be possible to make static HTML pages into APIs if their markup was more machine readable.

Many of the templates have basic microdata elements defined, but if one is missing please submit an issue/pull-request!

Development

All sources are combined into a bundle in ./static.

Tasks

build

Runs [browserify]((http://browserify.org/) and [minifyify]((https://npmjs.com/packages/minifyify) over the sources and creates a standalone bundle with sourcemap.

This will always be the script that generates the JS bundle in origin/master and npm.