mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-22 18:31:57 +03:00

History

kirrg001 132df78940 Updated docs links refs #9742 - Ghost 2.0 is coming - all doc links in 1.0 must use concrete links e.g. docs.ghost.org/v1 or themes.ghost.org/v1.23.0/ - if we release Ghost 2.0, docs.ghost.org will show 2.0 docs		2018-07-20 23:49:16 +02:00
..
assets/css	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
locales	Theme translations and blog localisation (#8437 )	2018-01-09 14:50:57 +01:00
partials	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
author.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
default.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
error-404.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
error.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
index.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
package.json	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
page.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
post.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01:00
README.md	Updated docs links	2018-07-20 23:49:16 +02:00
tag.hbs	Tests: Sort out usage of content folder in tests (#9034 )	2017-09-21 15:05:35 +01: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 and Gulp installed globally. After that, from the theme's root directory:

$ npm install

$ gulp

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

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.