Skip to content

A smooth blogging theme for Ghost, built using Casper.

License

Notifications You must be signed in to change notification settings

VirtuallyCreative/Faye

 
 

Repository files navigation

Faye

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

 

screenshot-desktop

 

Breakdown

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 Al"

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

Faye 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/faye.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

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

Copyright & License

Faye Theme - Copyright (c) 2020 - Al Romano - Released under the MIT license. Casper Theme - Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.

About

A smooth blogging theme for Ghost, built using Casper.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Handlebars 52.7%
  • CSS 35.2%
  • JavaScript 12.1%