Go to file

Renovate Bot d2ec8d1c31 Update dependency gulp-livereload to v4.0.2		2019-10-01 01:30:15 +00:00
.github	✨ Slack -> Forum	2018-04-02 16:35:21 +01:00
assets	Added max length for bookmark card publisher field (#608 )	2019-08-27 19:29:48 +01:00
partials	Added missing closing brackets in partials/header.hbs styles (#521 )	2019-01-22 11:04:03 +00: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	🔗 Updated docs link to be version-less	2019-07-25 14:56:04 +08:00
SECURITY.md	Updated links to docs site	2019-07-22 18:25:22 +08:00
author.hbs	🐛 Fixed author cover images not displaying	2019-03-08 08:47:58 +00:00
config.example.json	Extended `yarn ship`: more automation	2019-03-15 14:38:26 +01:00
default.hbs	Remove unused conditional	2019-08-21 13:53:47 +08:00
error-404.hbs	Update no-image classes	2019-01-15 15:06:19 +07:00
error.hbs	Substituted deprecated {{each}} helper with recommended {{foreach}}	2019-05-07 15:37:14 +02:00
gulpfile.js	Improve gulp globbing (#598 )	2019-08-21 13:51:43 +08:00
index.hbs	Use a larger logo size (#520 )	2019-01-15 22:51:08 +07:00
package.json	Update dependency gulp-livereload to v4.0.2	2019-10-01 01:30:15 +00:00
page.hbs	Responsive images (#505 )	2018-12-17 12:25:57 +00:00
post.hbs	Migrated from @blog -> @site	2019-01-08 17:37:14 +00:00
renovate.json	Update Renovate Configuration	2019-04-17 21:38:32 +01:00
tag.hbs	Responsive images (#505 )	2018-12-17 12:25:57 +00:00
yarn.lock	Update dependency gulp-livereload to v4.0.2	2019-10-01 01:30:15 +00: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.

We've documented our default theme pretty heavily so that it should be fairly easy to work out what's going on just by reading the code and the comments. 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 main template file
index.hbs - Used for the home page
post.hbs - Used for individual posts
page.hbs - Used for individual pages
tag.hbs - Used for tag archives
author.hbs - Used for author archives

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

page-about.hbs - Custom template for the /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:

$ yarn install
$ 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.

$ 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.