TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-19 16:42:17 +03:00
Code Issues Projects Releases Wiki Activity
b4682bf643
Ghost/ghost/zip/test/fixtures/test-theme/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
# Casper
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03: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.
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
 
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
![screenshot-desktop](https://user-images.githubusercontent.com/120485/27221326-1e31d326-5280-11e7-866d-82d550a7683b.jpg)
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
 
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
# First time using a Ghost theme?
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
Ghost uses a simple templating language called [Handlebars](http://handlebarsjs.com/) for its themes.
✨ feature: define redirects in a custom file (#7719) (#7945) refs #7707 - be able to add a custom redirect file into the content folder - define redirects as JSON format The redirects feature is already present in the LTS branch. I was not able to cherry-pick over, too many changes or conflicts. Creating a PR to ensure 1. tests pass and 2. overview of code changes. I had to add an example active theme to our test fixture utils, because otherwise Ghost will complain when forking Ghost.
2017-02-06 17:32:40 +03:00
Updated docs api links to be version-less
2019-07-25 10:17:23 +03:00
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://ghost.org/docs/api/handlebars-themes/) which explains every possible Handlebars helper and template.
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
**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:
Fixed tests no issue - replace test themes - otherwise they are all invalid with the new GScan version - fix general tests because of Ghost 2.0 logic
2018-08-12 17:31:08 +03:00
```bash
$ yarn install
$ yarn dev
```
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
Now you can edit `/assets/css/` files, which will be compiled to `/assets/built/` automatically.
Fixed tests no issue - replace test themes - otherwise they are all invalid with the new GScan version - fix general tests because of Ghost 2.0 logic
2018-08-12 17:31:08 +03:00
The `zip` Gulp task packages the theme files into `dist/<theme-name>.zip`, which you can then upload to your site.
```bash
$ yarn zip
```
Tests: Sort out usage of content folder in tests (#9034) no issue - use latest casper in test fixtures - never ever use the root content folder for tests - if we start/fork Ghost for the tests, we use a tmp folder - this change is required to for an upcoming PR (#9029) - i've added a TODO to create a helper fn for stopping the ghost server, so we can cleanup the tmp folder * Care about TODO's in our channels spec - add the 1.4 compatible casper theme to fixtures - so as soon as you start Ghost, the test env will provide the content folder in /tmp something with the activated latest default casper and the 1.4 compatible old casper - there are tests which tests different logici e.g. pagination - therefor we need a different theme, we are simply using our 1.4 casper
2017-09-21 17:05:35 +03:00
# 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
2022
2022-01-06 12:52:35 +03:00
Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
Reference in New Issue Copy Permalink