Vivid-Casper/README.md

70 lines
2.8 KiB
Markdown
Raw Normal View History

2013-08-24 23:01:45 +00:00
# Casper
2013-05-10 21:38:18 +00:00
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
The default theme for [Ghost](http://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.
2013-06-13 20:37:47 +00:00
2017-06-16 12:16:22 +00:00
 
2014-08-11 07:16:40 +00:00
2022-08-08 02:57:04 +00:00
![screenshot-desktop](https://user-images.githubusercontent.com/1418797/183329195-8e8f2ee5-a473-4694-a813-a2575491209e.png)
2017-05-15 20:03:47 +00:00
2017-06-16 12:16:22 +00:00
 
2017-06-16 09:44:06 +00:00
# First time using a Ghost theme?
Ghost uses a simple templating language called [Handlebars](http://handlebarsjs.com/) for its themes.
This theme has lots of code comments to help explain what's going on just by reading the code. Once you feel comfortable with how everything works, we also have full [theme API documentation](https://ghost.org/docs/themes/) which explains every possible Handlebars helper and template.
2017-06-16 09:44:06 +00:00
**The main files are:**
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
- `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
2017-06-16 09:44:06 +00:00
- `page.hbs` - Used for individual pages
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
- `tag.hbs` - Used for tag archives, eg. "all posts tagged with `news`"
- `author.hbs` - Used for author archives, eg. "all posts written by Jamie"
2017-06-16 09:44:06 +00:00
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
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:
2017-06-16 09:44:06 +00:00
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
- `page-about.hbs` - Custom template for an `/about/` page
2017-06-16 09:44:06 +00:00
- `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:
2017-05-15 20:03:47 +00:00
```bash
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
# install dependencies
yarn install
# run development server
yarn dev
```
2017-05-15 20:03:47 +00:00
2017-06-19 13:38:07 +00:00
Now you can edit `/assets/css/` files, which will be compiled to `/assets/built/` automatically.
2017-05-15 20:03:47 +00:00
The `zip` Gulp task packages the theme files into `dist/<theme-name>.zip`, which you can then upload to your site.
```bash
V3 (#626) * Changed {{code}} to {{statusCode}} refs https://github.com/TryGhost/gscan/commit/2ebd9feeee20c084a1d4ab84e5100cdb1e1400de - {{code}} use has been deprecated in canary rule set of gscan * V3 Update * Update package and readme for 3.0 * Improve install instructions * Update to support browserlist * Upgrade dependencies * Fix misnamed property * V3 darkmode (#619) Added dark mode styles * Casper final refinements batch 1 * Casper final refinements batch 2 * Fixed bookmark card hover bug * Fixed header social links * Updated screenshots * Updated readme no issue - refreshed screenshot * Udpate screenshot in readme no issue * 3.0.0-beta.2 * Fixed cut header for post cards no issue * 3.0.0-beta.3 * 3.0.0-beta.4 * Updated current version and previous version logic (#554) no issue - Use current version from `package.json` instead of `npm_package_version` env variable - Use `release.tag_name` instead of `release.name` for previous version * Updated jQuery to 3.4.1 to avoid known vulnerabilities (#590) no issue https://snyk.io/vuln/npm:jquery?lh=3.2.1&utm_source=lighthouse&utm_medium=ref&utm_campaign=audit * Fixed code cards with long lines from being too wide no issue Credits - https://github.com/TryGhost/Casper/pull/602 * Bumped gscan version to v3.0.0 (#621) * Bumped gscan to v3.0.0 - This also fixes failing CI builds because the default rules that are being checked were for v2 * Added explicit version check for gscan command * Added member subscription support (#623) * Added member subscription support no issue * Added member subscription success message no issue * Added member subscription overlay * Refined members subscription overlay * Deleted unused website icon * Ran CSSComb * Updated built assets * 3.0.0-beta.5 * Updated built assets for v3 no issue * 3.0.0-beta.6 * Remove unused partial * V3 cleanup (#625) * Removed unused infinity icon * Removed unused location icon * Removed unused 'point' icon * Removed unused Ghost logo icon * Removed unused author partials * Cleaned up index log * Fixed responsive feature image sizes for page template
2019-10-21 05:43:34 +00:00
# create .zip file
yarn zip
```
2017-06-16 09:44:06 +00:00
# PostCSS Features Used
2017-05-15 20:03:47 +00:00
- 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.
2020-07-27 17:59:13 +00:00
- [Color Mod](https://github.com/jonathantneal/postcss-color-mod-function)
2017-05-15 20:03:47 +00:00
2017-06-16 09:44:06 +00:00
# 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
2013-06-13 20:37:47 +00:00
2022-01-05 12:43:26 +00:00
Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).