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.
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 fileindex.hbs
- Used for the home pagepost.hbs
- Used for individual postspage.hbs
- Used for individual pagestag.hbs
- Used for tag archivesauthor.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/
pagetag-news.hbs
- Custom template for/tag/news/
archiveauthor-ali.hbs
- Custom template for/author/ali/
archive
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
- 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
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.
This theme comes with a default favicon generated with Real Favicon Generator. If you want to add your favicon you can generate your own (with Real Favicon Generator) and place downloaded files inside the assets/img/favicons Odin directory.
Disqus comments, Google Analytics and CookieBar are disabled by default, but they are easily configurable with Blog Header Code Injection inside your Ghost Admin Area.
<script>
// to enable Google Analytics
var ga_id = 'YOUR-UA-ID_HERE';
// to enable Disqus
var disqus_shortname = 'YOUR_DISQUS_SHORTNAME'
//to Enable the cookiebar (http://www.primebox.co.uk/projects/jquery-cookiebar/)
var cookieBarSettings = {
message: 'We use cookies to track usage and preferences',
acceptButton: true,
acceptText: 'I Understand'
};
//List of available CookieBar Settings
// message: 'We use cookies to track usage and preferences',
// acceptButton: true,
// acceptText: 'I Understand',
// acceptFunction: null,
// declineButton: false,
// declineText: 'Disable Cookies',
// declineFunction: null,
// policyButton: true,
// policyText: 'Privacy Policy',
// policyURL: '/privacy-policy/',
// autoEnable: true,
// acceptOnContinue: false,
// acceptOnScroll: false,
// acceptAnyClick: false,
// expireDays: 365,
// renewOnVisit: false,
// forceShow: false,
// effect: 'slide',
// element: 'body',
// append: false,
// fixed: false,
// bottom: false,
// zindex: '',
// domain: 'www.example.com',
// referrer: 'www.example.com'
</script>
Copyright (c) 2013-2019 Ghost Foundation - Released under the MIT license.