Paperleaf Ghost Theme Docs
Installation
If you need to setup Ghost please refer to https://ghost.org/docs/install/.
1) Upload theme to Ghost(Pro)
- To log in to your Ghost.org account visit Ghost.org and enter your Ghost.org login credentials.
- From your Ghost(Pro) dashboard, click on the “gear” icon to the right of the “Write a Post” button.
- Once on your blog’s control panel, you can either “drag & drop” your theme zip file into the “Add a Theme” drop zone, or click on the drag & drop zone to launch the traditional file upload prompt. Once uploaded, click on the Save all blog settings button. Your blog will automatically update with the new theme.
2) Upload theme to self hosted Ghost
- Log in to your Ghost administration (example: www.yourdomain.com/ghost).
- Go to
Designsettings and scroll to bottom. Click onUpload a themeand uploadpaperleaf-X.X.X.zipfile (X.X.X depending on theme version). - Click on
Activatebutton to activate theme on site and you are done!
Setup
- Upload
Publication logo(optional). The image will be displayed above site’s title. - Upload
Publication coveror remove default cover image (optional). This image is used for sidebar background. - Go to
Designsettings and add links that you want to display in sidebar.
Search setup
Go to Integrations settings then click on + Add custom integration. Add custom name like “GhostHunter” then click on “Create” button. Now you copy Content API key and then:
For Ghost > 4.20.0- Go to Settings > Design > Site-wide. Paste Content API key to Search key field. That’s it.For Ghost < 4.20.0- Go to Settings > Code injection. Paste Content API key to Site Header section like this:
<script>
// Replace YOUR API KEY with your actual key
var ghosthunter_key = 'YOUR API KEY';
</script>
Example:
<script>
var ghosthunter_key = 'c84b9745532df6251f4b320fbd';
</script>
Great, you’ve done it! Go to next section if you would like to setup memberships and/or subscriptions.
Memberships and subscriptions setup
- Go to
Settingsand click onPayments. - Expand
Connect to Stripesection and add your Stripe keys. Find your keys here. - Expand
Subscription pricingsection and set monthly and yearly price along with preferred currency. - Click on
Save members settings. - Go back to main
Settingspage and click onLabs. - Click on
Upload routes YAML. Selectroutes.ymlfrom ThemeForest downloaded zip file or from theme root folder on server. - You are done!
Authors page setup
- Create new page.
- Add page title.
- In
Page settingsselectAuthorsin Template dropdown (Hint: it is at very bottom of page settings sidebar). - Publish page and you are done!
Recommendations page setup
- Create new page.
- Add page title.
- Add content that will be brief description of recommendations page.
- In
Page settingsselectRecommendationsinTemplatedropdown (Hint: it is at very bottom of page settings sidebar). - Publish page and you are done!
How to customize theme?
Best way to customize theme is to use Code injection settings and add your custom CSS and JavaScript in Site Header or Site Footer sections. This way you will keep your modifications after new theme version is uploaded.
Other way to do it is to:
- For CSS you should edit
assets/css/dist/custom.cssfile and then uncommentline 18in default.hbs template. - For JavaScript you should edit
assets/js/dist/custom.jsfile and then uncommentline 50in default.hbs template.
Please copy these custom files when you are updating main theme files in order to keep your modifications.
Updating theme
If you did not change theme files then you only need to upload new theme files to your server.
If you made changes to main theme files then you need to copy your changes to new theme files.
Other information
Frameworks, scripts and plugins used in theme:
- jQuery - http://www.jquery.com
- FitVids.js - http://fitvidsjs.com/
- Masonry - http://masonry.desandro.com
- imagesLoaded - http://imagesloaded.desandro.com/
- jQuery Appear - https://github.com/morr/jquery.appear/