mirror of https://github.com/ViViDboarder/Vivid-Casper.git synced 2024-12-22 11:37:38 +00:00

Mirror of Casper fork

Go to file

Aileen Nowak bef56a2294 Minified js (#485 ) no issue - Added a `js` task to run on the gulp build process and minifies our js files - Changed the required scripts in `default.hbs` to use the minified js files in `/built/` - Moved existing `js` tasks from `zip` task		2018-10-12 12:41:06 +07:00
.github	✨ Slack -> Forum	2018-04-02 16:35:21 +01:00
assets	Minified js (#485 )	2018-10-12 12:41:06 +07:00
partials	Add titles to icon links	2018-10-12 12:01:05 +07:00
.editorconfig	Add the same .editorconfig as from the Ghost repository (#384 )	2017-09-18 09:35:53 -07:00
.gitignore	Add a Gulp task to create the zip (#374 )	2017-09-18 09:37:00 -07:00
.travis.yml	🛠 Added .travis.yml and gscan tests (#470 )	2018-08-14 22:10:01 +01:00
author.hbs	Remove unnecessary role attributes from main element	2018-04-17 22:19:05 +02:00
default.hbs	Minified js (#485 )	2018-10-12 12:41:06 +07:00
error-404.hbs	Remove unnecessary role attributes from main element	2018-04-17 22:19:05 +02:00
error.hbs	Remove unnecessary role attributes from main element	2018-04-17 22:19:05 +02:00
gulpfile.js	Minified js (#485 )	2018-10-12 12:41:06 +07:00
index.hbs	Remove unnecessary role attributes from main element	2018-04-17 22:19:05 +02:00
LICENSE	2018	2018-01-02 21:48:53 +00:00
package.json	Upgrading Casper to 2.6.4	2018-10-09 16:06:07 +02:00
page.hbs	🐛 Fixed image positioning on pages	2018-08-21 17:47:42 +01:00
post.hbs	Use id attribute to query reading progress element (#467 )	2018-08-03 09:21:05 +01:00
README.md	Link to required dependencies	2018-10-08 11:45:06 +07:00
tag.hbs	Remove unnecessary role attributes from main element	2018-04-17 22:19:05 +02:00
yarn.lock	Minified javascript in zip(#476 )	2018-10-08 16:34:07 +05:30

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.