WildBird | Ghost Theme Documentation v3.0.0
Theme Documentation
First of all a huge thanks for purchasing this theme! If you have any questions that are not answered here, please feel free to contact us via (email). Thanks so much!
Table of Contents
- Theme Information
- Theme Installation
- Theme Structure
- Getting Started
- Theme Customization
- Credits
- Support
- Updates
1. Theme Information
- Name: WildBird
- Current Version: 3.0.0
- Last Updated: 14 October, 2022
- Ghost version: >= 5.x
2. Theme Installation
- Log into the admin section of your Ghost blog:
yourblog.com/ghost
. - Go to Settings → Design and click on Change theme located at the bottom of the left hand column.
- Click on Upload theme.
- Drag-and-drop or click and locate the zip file for your theme.
- Once it is uploaded, click on either Activate to activate the theme immediately or Close if you want to activate it later on.
3. Theme Structure
Here’s an overview of the main theme files:
default.hbs
- The parent template file that includes the global header and footer.index.hbs
- The main template that generates a list of posts.home.hbs
- The template that provides special content for the home page, i.e. featured posts carousel.post.hbs
- The template used to render single posts.page.hbs
- The template used to render static pages.author.hbs
,tag.hbs
- The templates used for author and tag archives respectively.error.hbs
,error-404.hbs
- The templates for any 500 or 404 errors.routes.yaml
- Ghost’s routing configuration which you should upload if the members feature is enabled.
4. Getting Started
4.1 Uploading a Favicon
To add a favicon:
- Navigate to Settings → Design in your Ghost admin.
- Expand the Brand section.
- Click Upload icon next to Publication icon.
- Save changes.
4.2 Uploading a Publication Logo
To add a logo:
- Navigate to Settings → Design in your Ghost admin.
- Expand the Brand section.
- Click Upload logo next to Publication logo.
- Save changes.
4.3 Uploading a Publication Cover
The publication cover image is displayed in the background of the error pages.
To add a publication cover:
- Navigate to Settings → Design in your Ghost admin.
- Expand the Brand section.
- Click Upload image next to Publication cover.
- Save changes.
4.4 Adding Navigation
The theme supports primary and secondary navigation. Primary navigation is displayed in the sidebar, while the secondary navigation is displayed in the site footer.
To set up primary and secondary navigation:
- Go to Settings → Navigation in your Ghost admin.
- Add your navigation items by entering a page name in the label field and a destination URL in the URL field.
- Once finished, click Save.
4.5 Adding Social Media Links
The social media links are displayed in the sidebar of the theme.
To add Facebook and Twitter links:
- Navigate to Settings → General in your Ghost admin.
- Click Expand next to Social accounts.
- Enter the URLs of your Facebook and Twitter profiles.
- Save changes.
All other social media links can be added manually in the widget-social.hbs
file located in the partials folder of the theme. For instance, if you want to add the link to your Instagram account use the following code:
<a href="https://www.instagram.com/" target="_blank" rel="noopener" aria-label="Instagram"><span class="screen-reader-text">Instagram</span>{{> "icons/instagram"}}</a>
4.6 Adding Featured Posts
You can feature up to three of your posts. The featured posts are displayed on the homepage below the hero section.
To mark a post as featured:
- Navigate to Posts in your Ghost admin.
- Create a new post or open an existing one.
- Click on the post settings icon in the top right corner of the Ghost editor.
- Check the Feature this post box located at the bottom of the posts settings panel.
- Save changes.
4.7 Members
Ghost members feature allows you to turn your site into a membership business with member signup, paid subscriptions and email newsletters.
If members feature is enabled on your site, the theme displays Subscribe and Sign in links in the sidebar and the Subscribe box above the footer. Both, sidebar links and subscribe box button, open the Ghost members portal.
If you wish, you can enable the labels on the posts indicating the post access level (Free or Paid). To do this:
- Navigate to Settings → Design in your Ghost admin.
- Expand the Site-wide section.
- Select the option from the Post access labels dropdown.
- Save changes.
4.9 Enabling Comments
Member commenting can be enabled for either All members or Paid-members only from within Ghost Admin, in the Settings → Membership area.
4.10 Adding Google Analytics
To add Google Analytics to your site, please follow the Google Analytics Integration guide by Ghost.
5. Theme Customization
5.1 Changing Accent Color
To change the theme accent color:
- Navigate to Settings → Design in your Ghost admin.
- Expand the Brand section.
- Choose your color.
- Save changes.
5.2 Changing Posts Per Page Number
You can set the number of post displayed per page in the package.json file of the theme. The default post number is set to 8:
"config": {
"posts_per_page": 8
}
5.3 Theme Translation
The Royce theme is ready for translations. You can find the default file in the locales
folder. Copy locales/en.json
to locales/[language_code].json
where “language_code” must be replaced with a valid code. You can edit the renamed translation file with any plain text editor.
Even if your site is in English, you can customize any theme texts by simply editing the default English file (locales/en.json
), without modifying the theme templates.
You can find more information on how to translate the theme in Ghost documentation.
Please note that currently there is no way to translate or edit the Portal text. The Portal is not the part of the theme files but a core Ghost component.
6. Credits
- Lato font: https://www.google.com/fonts/specimen/Lato
- Playfair Display font: https://www.google.com/fonts/specimen/Playfair+Display
- Simple Icons SVG icons: https://simpleicons.org/
- FitVids plugin: https://github.com/davatron5000/FitVids.js
- Slick Carousel plugin: https://github.com/kenwheeler/slick/
- SimpleLightbox plugin: https://github.com/andreknieriem/simplelightbox
7. Support
The documentation included provides all the information needed to get the theme installed and customized. However, if you have any questions you can email us at support@justgoodthemes.com, and we will be happy to help you.
If you have any bug reports, or feature requests, please let us know!
8. Updates
As Ghost platform grows, so will this theme. We’re dedicated to keeping our WildBird up to date.