A simple theme for Octopress and Jekyll focusing on copy and images
HTML CSS JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
sass Add symbola to symbol fonts Aug 31, 2015
source
.gitignore Add theme Jul 8, 2013
LICENSE.md Add LICENSE and README Jul 8, 2013
README.md Allow adding classes to main article element May 10, 2015

README.md

typo (tīˈpō)

n. Informal a simple theme for Octopress and Jekyll by Sam Whited.

A live preview can be found here.

Extra requirements

This theme requires that you update your Gemfile to use a at least liquid 2.5.0:

gem 'liquid', '~> 2.5.0'

Configuration

page.article_class: nil

Extra classes to add to the posts overall article element (eg. to center the post, but keep text left aligned: article_class: centering).

page.bootstrap: false

If true, load Bootstrap.js on the current page.

page.content_class: nil

Extra classes to add to the posts .entry-content div (eg. for centering content: content_class: centering).

page.cover: nil

An image to display above the post.

page.cover_alt: nil

The alt text for the cover photo. Set to an empty string if not present.

page.cover_caption: nil

A caption for the photo. Sets the data-caption attribute if present which is then rendered below the photo using some CSS.

page.cover_link: nil

Where page.cover should link too. If empty (default), no link is generated.

page.cover_title: nil

The title text for the cover photo. No title attribute generated if left nil.

page.cover_width: nil

The width in pixels (don't specify the units) of the cover image displayed above the post. This overrides site.cover_width if present.

page.edge_fonts: nil

An Adobe Edge Fonts line to import. Eg. advent-pro;aladin. This does NOT override the site specific option; instead, it loads the fonts in addition to any site wide fonts.

page.excerpt: nil

Overrides the post excerpt that will be shown on the index page. If this is not present then page.description is checked, if that is not present then the actual excerpt is used. If the actual excerpt or page.description are used they are stripped of all HTML and limited to site.excerpt_max_length words; page.excerpt on the other hand will use the raw string and ignore length.

page.google_fonts_family: nil

A Google Fonts family line to import. Eg. Open+Sans:400,600italic&subset=latin,cyrillic-ext. This does NOT override the site specific option; instead, it loads the font in addition to any site wide fonts.

page.lettrine: nil

Set to false to prevent generation of a lettrine (aka an 'Initial') for the first paragraph of a post or for the first paragraph following the first h2.

page.mapbox: nil

When set, load Mapbox.js for rendering maps. By default, we treat any element with the map class as a map and load the Mapbox ID from that element's data-map attribute. If the data-geojson attribute is present, its value is treated as GeoJSON and loaded onto the map. GeoJSON files can also be automatically loaded from GitHub if a data-github attribute is present on the element. This should point to a GeoJSON file using the GitHub API, eg: https://api.github.com/repos/mapbox/mapbox.js/contents/test/manual/example.geojson. You can also load a generic GeoJSON file by passing the data-src attribute. Any URL specified by this attribute is subject to the Same origin policy so if the JSON is not in the same domain as the script, the server delivering it must support CORS.

page.cover_in_gallery: true

Include or exclude the pages cover photo from the gallery.

page.square_thumb: false

Set this to disable the circular effect on post thumbnails.

page.subtitle: nil

A subtitle to be shown under the regular title.

page.thumbnail: nil

An image to display as the 150×150px thumbnail above the post on the index page.

site.bootstrap: false

If true, load Bootstrap.js on all pages.

site.cover_width: 640

The width in pixels (don't specify the units) of the cover image displayed above each post (does not affect the thumbnail image on the index page).

site.disqus_short_name: nil

An ID for enabling comments with Disqus.

page.edge_fonts: nil

An Adobe Edge Fonts line to import. Eg. advent-pro;aladin.

site.excerpt_max_length: 25

The number of words from the post excerpt to show on the index page.

site.google_plus_comments: false

Enable comments using Google Plus.

site.google_fonts_family: nil

A Google Fonts family line to import. Eg. Open+Sans:400,600italic&subset=latin,cyrillic-ext.

site.header_title: nil

A title to be shown at the top of the index page (in case you want to style it differently from the normal blog's title).

site.openid_server: nil
site.openid_delegate: nil

Specifies an OpenID provider to delegate OpenID 1.1 and 2.0 requests to (support for OpenID Connect requires a separate WebFinger file which you can create yourself).

site.posts_per_row: 4

The number of posts to include per row on the index page (make sure paginate is high enough).

site.search_posts: false

Turn on search suggestions from post titles, excerpts, and descriptions using a technique derived from François Zaninotto's client side full-text search implementation. For blogs with large numbers of posts this may slow down page load times.

site.typekit_kitid: nil

An Adobe Typekit kit ID for including webfonts.

Attributes

h2 data-accent="string"

Any h2 element inside of a posts content is prefixed with by default. Adding a data-accent tag to the h2 can be used to customize this accent character.

div data-caption="string"

Adds some text after the div. Useful for adding captions to images. This also works for a and img tags but isn't recommended (note that some browsers, most notably Firefox, won't allow the before and after psudo elements to have content if the original element cannot have content, eg. img tags).