Skip to content
Download the Ghost Themes Bundle for only $249 — Use BUNDLE code for 10% discount 🔥
← Back to Documentations

Aspire Documentation - Ghost

Current Version: 1.5.7 - 20 July 2020 Changelog →



Theme Installation

The first step is to unzip the downloaded package and you will find the actual theme inside besides a documentation file. Then do the following steps to upload the theme to your blog.

  • Log in to the admin section of your Ghost blog yourblog.com/ghost.
  • Select Design from the left-hand side of your admin area and go to the INSTALLED THEMES section.
  • Click on the Upload a theme green button.
  • An upload box will open, then choose the theme file (aspire.zip).
  • Once uploaded. Click on Activate now button to activate the theme immediately or Close if you want to activate it later.

Create a New Content API Key

In order for the Search to work, we need to generate a new Content API Key using the following steps.

From Ghost admin, click Integrations from the sidebar menu, then click + add custom integration.

Add new Ghost Custom integrations

Then, give the new integration a name, for example, Search and click Create.

Name for the Ghost Custom integrations

Now, a new Key is created, hover over it and the new Copy button will appear, click on it to copy the Key to the clipboard.

Copy Ghost Custom integrations Content API Key

Next, click Code injection from the sidebar menu and add the following code to the Blog Header box after replacing the XXXX value with your API KEY.

<script>
  var search_api_key = 'XXXX';
</script>

To be like:

Inject Ghost Custom integrations Content API Key

Click Save.


You can add, edit, delete and reorder menu links on your Ghost blog from the Navigation section in the admin area located at ghost/#/settings/design.

navigation menu

To include a static page on your navigation menu. First, type the name of the page as you’d like it to appear on your menu in the label field.

label field

Next, click on the URL field of the menu item and we can find that the blog URL is already auto-populate for us. We will need to add the page slug after the final /. Once satisfied with our page configurations. Clicking the blue Save button will add the page to the navigation menu.


For the search to work, please make sure to Create a New Content API Key.


Tags Page

To create the Tags page:

  • From the Ghost admin Pages section, create a new page and call it Tags for example.
  • From Page settings, select the Tags template from the Template dropdown.
  • Publish the page.
  • To add the page to the navigation, please check the Navigation section above.

Ghost Tags Page


Disqus Comments

Open partials/disqus.hbs file. Change the aspirethemes-demos value for the disqus_shortname variable to match your Disqus account shortname.

var disqus_shortname = 'aspirethemes-demos';

So, if your Disqus shortname is exampleone, the final code above should be:

var disqus_shortname = 'exampleone';

That’s all you need to setup Disqus from the theme side. If you get any issue that comments are unable to load. First, make sure you have registered your website with Disqus (Step 1)

And also check Disqus troubleshooting guide if you still have issues.


Disable Disqus

If you want to disable Disqus comments. Open the post.hbs file and comment or delete the line contains the {{> disqus}} text (line 93).


Twitter

To set up the Twitter feed:

  • Go to publish.twitter.com.
  • Enter a Twitter URL into the input box and press Enter.
  • Select Embedded Timeline.
  • You will see a Timeline preview and you can customize it as required.
  • Copy the code by clicking the Copy Code button.
  • Open partials/sidebar/widget-twitter.hbs file and replace line 4 with the copied code.
  • Save and you are done.
 

If you want to add an advertisement widget to your sidebar, this widget is the way to go. This will enable you to add an image and a URL associated with it, all you need to do is:

  • Replace your custom image with the image located in the theme directory (assets/images/ads.jpg).
  • Update partials/sidebar/widget-ads.hbs file with the URL (href) value.
  • Add an alternative text to the image (alt value) like the following image.

Advertise Widget Code


If you want to remove the Advertise Widget, you can remove or coment the {{> sidebar/widget-ads}} line inside the partials/sidebar.hbs file.

Sidebar Partials Code


Posts Per Page

You can control how many posts to show per page from the package.json file like this:

"config": {
  "posts_per_page": 12
}

The theme default value is set to 12 posts per page.


Related posts will be visible on the single post in case there are similar posts sharing the same tags.

Enabling the Public API required.


If you want to remove the related posts section, you can remove or coment the {{> related-posts}} line inside the post.hbs file (line 108).

Remove Related Posts Section


Google Analytics

To integrate Google Analytics. I would recommend reading Google Analytics integration steps by Ghost.


Subscribe Form

Subscribers can be enabled via a checkbox on the Labs page (Labs > Beta features), in your Ghost admin panel:

enable subscribers

Once you enabled this feature, the form will appear in three places:

  • Footer
  • Single post page sidebar widget
  • Single post page after the article

You can read more about Subscribers Beta.


Social Sharing Icons

You can customize and update the post social media icons from the theme partials/share.hbs file.


Social Media Icons

Social media links are placed in 3 different places (files):

  • partials/footer.hbs
  • partials/social-nav.hbs
  • partials/sidebar/widget-social.hbs

Ghost supports adding Facebook and Twitter profile URLs from the admin panel, go to General > Social accounts and add your URLs, this will update the Facebook and Twitter URLs within the 3 locations mentioned above.

social-accounts

For using other social accounts, the theme is using Evil Icons, which contains very simple and clean icons. Here you can find a list of the social media icons to use:

Facebook

<span data-icon='ei-sc-facebook' data-size='s'></span>

GitHub

<span data-icon='ei-sc-github' data-size='s'></span>

Instagram

<span data-icon='ei-sc-instagram' data-size='s'></span>

LinkedIn

<span data-icon='ei-sc-linkedin' data-size='s'></span>

Odnoklassniki

<span data-icon='ei-sc-odnoklassniki' data-size='s'></span>

Pinterest

<span data-icon='ei-sc-pinterest' data-size='s'></span>

Skype

<span data-icon='ei-sc-skype' data-size='s'></span>

SoundCloud

<span data-icon='ei-sc-soundcloud' data-size='s'></span>

Telegram

<span data-icon='ei-sc-telegram' data-size='s'></span>

Tumblr

<span data-icon='ei-sc-tumblr' data-size='s'></span>

Twitter

<span data-icon='ei-sc-twitter' data-size='s'></span>

Vimeo

<span data-icon='ei-sc-vimeo' data-size='s'></span>

VK

<span data-icon='ei-sc-vk' data-size='s'></span>

Youtube

<span data-icon='ei-sc-youtube' data-size='s'></span>

To edit or update other excisted and static social links, let’s take an example from partials/social-nav.hbs file, for exmaple, the Instagram code block:

<li class='c-social-nav__item'>
  <a href='#' aria-label='Instagram' target='_blank' rel='noopener'>
    <span class='c-social-nav__icon' data-icon='ei-sc-instagram' data-size='s'></span>
  </a>
</li>

The code above contains the ICON code from the above list, the social media link (a) within a list element (li).

Next, replace your Instagram full URL with the link href value so if your Instagram URL is:

https://www.instagram.com/ghost/

the new code will be:

<li class='c-social-nav__item'>
  <a href='https://www.instagram.com/ghost/' aria-label='Instagram' target='_blank' rel='noopener'>
    <span class='c-social-nav__icon' data-icon='ei-sc-instagram' data-size='s'></span>
  </a>
</li>

If you want to completely remove Instagram, you can delete all the code block, the li, a, and the icon.

This concept is applied to all the custom icon list available in the 3 social media places.


Update Favicon

You can change the favicon in Ghost from the Admin > General > PUBLICATION IDENTITY > Publication icon from the Publication icon section.

Update favicon


Theme Translation

Nubia supports Ghost i18n and comes with German, Italian, Spanish, French Finnish, Portuguese Dutch, Turkish and Danish translation.

To use another available language than English, go to Admin > General > PUBLICATION INFO> Publication Language and enter the Language Code Reference.

  • de for Germany
  • it for Italian
  • es for Spanish
  • fr for French
  • fi for Finnish
  • pt for Portuguese
  • du for Dutch
  • tr for Turkish
  • da for Danish

Ghost Publication Language Setting


Add New Language

To add a new language, follow the following steps:

  • Create a new file under the theme locales folder with the language ISO Code code. So, if the new language will be Arabic, the new file name will be ar.json.
  • Copy the en.json file content into your new file and start to translate as shown in the following section.
  • Go to Admin > General > PUBLICATION INFO > Publication Language and enter the language code which will be ar in this example.

Edit Translation

To improve or edit a translation in a specific available language. You can open the language file under locales folder:

|____locales
| |____da.json
| |____de.json
| |____du.json
| |____en.json
| |____es.json
| |____fi.json
| |____fr.json
| |____it.json
| |____pt.json
| |____tr.json

For example the Germany translation file will look like:

{
  "Next": "Weiter",
  "Previous": "Zurück",
  " (Page %)": " (Seite %)",
  "Page Not Found": "Seite nicht gefunden",
  "Recent Posts": "kürzliche Artikel",
  "Home Page": "Startseite",
  "Featured Post": "Featured Artikel",
  "Share on Twitter": "Auf Twitter teilen",
  "Share on Facebook": "Auf Facebook teilen",
  "Share on Pinterest": "Auf Pinterest teilen",
  "Search": "Suche",
  "Search {blogtitle}": "Suche {blogtitle}",
  "Type to Search": "Tippe um zu suchen",
  "Published with {ghostLink} & {themeLink}": "Veröffentlicht mit {ghostLink} & {themeLink}",
  "You Might Be Interested In": "Sie könnten daran interessiert sein",
  "Newsletter": "Newsletter",
  "Follow": "Folgen",

  "Email": "E-Mail",
  "Log In": "Einloggen",
  "Sign Up": "Anmelden",
  "Continue": "Fortsetzen",
  "Subscribe": "Abonnieren",
  "Subscribe Now": "Abonniere jetzt",
  "Enter your email below to join our newsletter": "Geben Sie Ihre E-Mail-Adresse unten ein, um unserem Newsletter beizutreten",
  "Please check your inbox and click the link to confirm your subscription.": "Bitte überprüfen Sie Ihren Posteingang und klicken Sie auf den Link, um Ihr Abonnement zu bestätigen.",
  "Please enter a valid email address!": "Bitte geben Sie eine gültige E-Mail-Adresse ein!",
  "An error occurred, please try again later.": "Ein Fehler ist aufgetreten. Bitte versuchen Sie es später erneut.",

  "You've successfully subscribed to {siteTitle}": "Sie haben {siteTitle} erfolgreich abonniert.",
  "Great! Next, complete checkout for full access to {siteTitle}": "Toll! Schließen Sie als Nächstes die Prüfung ab, um vollen Zugriff auf {siteTitle} zu erhalten.",
  "Welcome back! You've successfully signed in.": "Willkommen zurück! Sie haben sich erfolgreich angemeldet.",
  "Success! Your account is fully activated, you now have access to all content.": "Erfolg! Ihr Konto ist vollständig aktiviert, Sie haben nun Zugriff auf alle Inhalte.",

  "Already have an account?": "Hast du schon ein Konto?",
  "Don't have an account yet?": "Sie haben noch keinen Account?",

  "This post is for paying subscribers only": "Dieser Beitrag ist nur für zahlende Abonnenten",
  "This post is for subscribers only": "Dieser Beitrag ist nur für Abonnenten",

  "Choose your subscription": "Wählen Sie Ihr Abonnement",
  "Unlock full access to {siteTitle} and see the entire library of members-only content & updates.": "Schalte den vollen Zugriff auf {siteTitle} frei und sieh dir die gesamte Bibliothek mit Inhalten und Updates nur für Mitglieder an.",
  "Sign Up to {siteTitle}": "Anmelden bei {siteTitle}",

  "Welcome back!": "Willkommen zurück!",
  "Log Into your account again.": "Melden Sie sich erneut in Ihrem Konto an.",
  "Send login link": "Anmeldelink senden",

  "Nice, you're a subscriber!": "Schön, dass Sie Abonnent sind!",
  "You have an active {siteTitle} account with access to all posts.": "Sie haben ein aktives {siteTitle} Konto mit Zugriff auf alle Posts.",
  "You're a subscriber to free members updates": "Sie sind Abonnent der kostenlosen Mitgliederaktualisierungen",
  "You are subscribed to free updates from {siteTitle}, but don't have a paid subscription to read all the posts.": "Sie haben kostenlose Updates von {siteTitle} abonniert, haben jedoch kein kostenpflichtiges Abonnement, um alle Beiträge zu lesen."
}

Each line consist of a left key ("Next") and right value ("Weiter"). The key is a plain Englich which exist in all translation files and should not be changed. You can only change the value.

If you have suggestions to improve the current translations or added a new language. Please let me know. Instead, you can contribute to the online translations.


Theme Deploy with GitHub Actions

Aspire Documentation comes integrated with the amazing Deploy Ghost Theme Github action.

Aspire Documentation GitHub Actions

I have written about this at How to Deploy Your Ghost Theme Using Github Actions. All you need to do it to follow steps 1 and 2.


Theme Development

If you are a developer and need to do heavy customization work. The theme is using Gulp to compile Sass and JavaScript. This improves the development flow and making it much faster.

NOTE: Changing any hbs file, for example the post.hbs file does not require being in a development mode with gulp running. Just edit the file in your preferred editor and upload it.

First, make sure you have Node.js, npm, Gulp CLI, and Bower installed. Run the following command in the theme root directory to install npm and bower dependencies.

npm install

To start Gulp, run:

gulp

This will compile Sass and JavaScript files, and start watching changes as you edit files.

Gulp will generate two files:

  • assets/js/app.min.js: The final main JavaScript file.
  • partials/compiled/inline-css.hbs: The final CSS file.

It’s recommended to avoid editing these files if you are working with Gulp. Instead, do customizations in assets/sass files for CSS or in assets/js/app.js for JavaScript. So, we can make sure the flow is going in the right direction and we never lost any changes.


Code Injection

Another option for customization, is to use the Ghost Code Injection settings in Ghost Admin. For a CSS example, you can use the following code to change the logo color as:

<style>
  .c-logo__link { color: #4550E5; }
</style>

Zip Theme Files

To create a clean and small theme package. You can exclude different directories using the following command line:

zip -r aspire.zip aspire -x '*node_modules*' '*bower_components*'

This will exclude node_modules, and bower_components directories from the final zip file.

If you are running gulp, you can type the gulp zip command to do this.


Theme Update

You may be asking: How can I update my theme to the latest theme version?

There are two options:

  • Keep your current theme and only replace the changed files from the new version. You can find the changed files on the theme page Changelog.

  • Or, use the new version as a starting point and redo your theme changes and customizations.

One thing to reduce the need for redoing customization is to use the Code Injection tool. This is very helpful for adding custom CSS and tracking code for example. So, it’s always recommended to keep your custom CSS code with Code Injection.


👋 Support

Have any questions? I'm always here to help 😊

Contact Ahmad
Ahmad Ajmi Photo
Ahmad Ajmi