Go to file

Amgaa a1fc6090d2 Very small fix on author meta links color		2019-10-30 11:35:29 +01:00
.github	Update deploy-theme.yml	2019-10-21 12:49:04 +01:00
assets	Very small fix on author meta links color	2019-10-30 11:35:29 +01:00
partials	Error page improvements (#639 )	2019-10-28 16:28:25 +01:00
.editorconfig	Add the same .editorconfig as from the Ghost repository (#384 )	2017-09-18 09:35:53 -07:00
.gitignore	Extended `yarn ship`: more automation	2019-03-15 14:38:26 +01:00
.travis.yml	Updated travis.yml file	2019-04-18 14:10:35 +01:00
.yarnrc	Added .yarnrc	2019-03-15 14:38:26 +01:00
LICENSE	2019	2019-01-01 14:18:28 +00:00
README.md	V3 (#626 )	2019-10-21 12:43:34 +07:00
SECURITY.md	Updated links to docs site	2019-07-22 18:25:22 +08:00
author.hbs	V3 (#626 )	2019-10-21 12:43:34 +07:00
config.example.json	Extended `yarn ship`: more automation	2019-03-15 14:38:26 +01:00
default.hbs	V3 (#626 )	2019-10-21 12:43:34 +07:00
error-404.hbs	Error page improvements (#639 )	2019-10-28 16:28:25 +01:00
error.hbs	Error page improvements (#639 )	2019-10-28 16:28:25 +01:00
gulpfile.js	Fixed deprecated autoprefixer config warning when running build tasks	2019-10-20 16:05:37 +02:00
index.hbs	V3 (#626 )	2019-10-21 12:43:34 +07:00
package.json	3.0.1	2019-10-29 14:20:08 +00:00
page.hbs	V3 (#626 )	2019-10-21 12:43:34 +07:00
post.hbs	Fixed sticky title and author hover JS (#629 )	2019-10-21 10:02:05 +01:00
renovate.json	Update Renovate Configuration	2019-04-17 21:38:32 +01:00
tag.hbs	V3 (#626 )	2019-10-21 12:43:34 +07:00
yarn.lock	Fixed deprecated autoprefixer config warning when running build tasks	2019-10-20 16:05:37 +02:00

README.md

Casper

The default theme for Ghost. This is the latest development version of Casper! If you're just looking to download the latest release, head over to the releases page.

First time using a Ghost theme?

Ghost uses a simple templating language called Handlebars for its themes.

This theme has lots of code comments to help explain what's going on just by reading the code. Once you feel comfortable with how everything works, we also have full theme API documentation which explains every possible Handlebars helper and template.

The main files are:

default.hbs - The parent template file, which includes your global header/footer
index.hbs - The main template to generate a list of posts, usually the home page
post.hbs - The template used to render individual posts
page.hbs - Used for individual pages
tag.hbs - Used for tag archives, eg. "all posts tagged with news"
author.hbs - Used for author archives, eg. "all posts written by Jamie"

One neat trick is that you can also create custom one-off templates by adding the slug of a page to a template file. For example:

page-about.hbs - Custom template for an /about/ page
tag-news.hbs - Custom template for /tag/news/ archive
author-ali.hbs - Custom template for /author/ali/ archive

Development

Casper styles are compiled using Gulp/PostCSS to polyfill future CSS spec. You'll need Node, Yarn and Gulp installed globally. After that, from the theme's root directory:

# install dependencies
yarn install

# run development server
yarn dev

Now you can edit /assets/css/ files, which will be compiled to /assets/built/ automatically.

The zip Gulp task packages the theme files into dist/<theme-name>.zip, which you can then upload to your site.

# create .zip file
yarn zip

PostCSS Features Used

Autoprefixer - Don't worry about writing browser prefixes of any kind, it's all done automatically with support for the latest 2 major versions of every browser.
Variables - Simple pure CSS variables
Color Function

SVG Icons

Casper uses inline SVG icons, included via Handlebars partials. You can find all icons inside /partials/icons. To use an icon just include the name of the relevant file, eg. To include the SVG icon in /partials/icons/rss.hbs - use {{> "icons/rss"}}.

You can add your own SVG icons in the same manner.