-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d948fab
commit de4d77d
Showing
13 changed files
with
283 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Casper | ||
|
||
The default theme for [Ghost](https://github.com/tryghost/ghost/). This is the latest development version of Casper. If you're just looking to download the latest release, head over to the [releases](https://github.com/TryGhost/Casper/releases) page. | ||
|
||
| ||
|
||
![screenshot-desktop](https://user-images.githubusercontent.com/120485/27221326-1e31d326-5280-11e7-866d-82d550a7683b.jpg) | ||
|
||
| ||
|
||
# First time using a Ghost theme? | ||
|
||
Ghost uses a simple templating language called [Handlebars](http://handlebarsjs.com/) 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](https://themes.ghost.org) 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](https://nodejs.org/), [Yarn](https://yarnpkg.com/) and [Gulp](https://gulpjs.com) installed globally. After that, from the theme's root directory: | ||
|
||
```bash | ||
$ 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. | ||
|
||
```bash | ||
$ 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](https://github.com/postcss/postcss-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. | ||
|
||
|
||
# Copyright & License | ||
|
||
Copyright (c) 2013-2018 Ghost Foundation - Released under the [MIT license](LICENSE). |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.