Mirror of Casper fork

Go to file

John O'Nolan e3fd4d707e 2021		2021-01-25 15:58:47 +00:00
.github	Added main as a deploy branch for theme uploading	2021-01-07 13:50:49 +00:00
assets	Fix text fragment scrolling which behind the floating top bar	2021-01-22 10:02:51 +08:00
partials	Post cards > Lazyload (#701 )	2020-04-03 14:35:58 +07: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
.yarnrc	Added .yarnrc	2019-03-15 14:38:26 +01:00
LICENSE	2021	2021-01-25 15:58:47 +00:00
README.md	2021	2021-01-25 15:58:47 +00:00
SECURITY.md	Updated links to ghost.org sites	2021-01-19 13:30:21 +13:00
author.hbs	Show members-only posts in the post loop by default	2021-01-05 15:47:56 +08:00
config.example.json	Updated release script	2020-04-03 16:16:26 +01:00
default.hbs	Updated links to ghost.org sites	2021-01-19 13:30:21 +13: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	Upgraded to color-mod, native CSS vars	2020-07-28 00:52:31 +07:00
index.hbs	Show members-only posts in the post loop by default	2021-01-05 15:47:56 +08:00
package.json	Update dependency autoprefixer to v10.2.3	2021-01-19 19:59:47 +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	Updated Renovate config with new structure	2020-03-26 10:56:13 +00:00
tag.hbs	Show members-only posts in the post loop by default	2021-01-05 15:47:56 +08:00
yarn.lock	Update dependency autoprefixer to v10.2.3	2021-01-19 19:59:47 +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.

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.
Color Mod

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.