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

Maxima Documentation

Current Version: 1.2.8 - 20 July 2020 Changelog →


To edit the theme files mentioned here, use your text editor of choice. For example, you can use Visual Studio Code ↗ or Sublime Text ↗.

Once finished your changes, zip the theme files, and upload the final zip file to Ghost.



Theme Installation

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

  • Log in to your Ghost website admin (example.com/ghost)
  • In the left-side menu of your admin click Design
  • Scroll down to the INSTALLED THEMES section
  • Click Upload a theme
  • Select the theme file (maxima.zip)
  • Once uploaded, click on Activate now to activate the theme immediately or Close if you want to activate it later

Create a New Content API Key

In order for the theme search to work, make a new Content API Key by following the next steps.

In the left-side menu of your Ghost admin click Integrations then + 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 API Key is created, hover over it and the 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 left-side admin menu.

Add the following code to the Site Header box after replacing the API_KEY value with your API Key.

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

To be like.

Inject Ghost Custom integrations Content API Key

Click Save.


Upload the routes.yaml File

The routes.yaml file is required for members sign up and subscription flows.

To upload the file.

  • Go to the Ghost admin Labs settings page (/#/settings/labs)
  • Scroll down to the Routes section and click the Upload routes YAML button
  • Select and upload the routes.yaml file inside the theme zip file

Upload a routes file in Ghost

Note

  • You need to upload the routes.yaml separately. Uploading the theme zip file is not enough.
  • There is already a routes.yaml file uploaded to Ghost. This is the default one that comes with Ghost. We need to upload the theme one to override it.


Members / Subscription

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

enable subscribers

Once enabled, different parts of the theme will appear:

  • Login In and Sign Up buttons in the sidebar.
  • Post subscription form.
  • Call to action section in Post page to encourage visitors to subscribe if the post is set to Members only.

In order for the blog to fully supports member sign up flows and subscriptions, within the theme folder is a routes.yaml file. Upload this single file using Routes on the Labs page.

Upload a routes file in Ghost


To edit each plan features, edit the partials/signup-plans.hbs file.

Subscription plans in Maxima


Membership Troubleshooting Tips

If for any reason the subscribe form does not work or there is an error message, you may check out the following tips:

  1. If you are self-hosting your website, make sure to set up the mail config. After doing that, restart your Ghost server.

  2. The website config URL should match the URL used to access the website. As described in the Ghost docs.

Enter the URL that is used to access your publication. If using a subpath, enter the full path, https://example.com/blog/. If using SSL, always enter the URL with https://..


For more information about Members, connecting Stripe, and setting the package price, check the official Ghost documentation.


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.

Ghost 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.

Ghost 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.


The theme uses ghostHunter.

Search is done for the Post title and the content. Search only support Posts but not Pages.

The search supports German, Spanish, French, Portuguese, Italian, Finnish, Dutch, Turkish, and Danish.


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, choose 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

Note

If you are self-hosting your website, you may need to do a server restart. This will help show up the Template dropdown Tags option.


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 set up 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 the 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 97).


Posts Per Page

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

"config": {
  "posts_per_page": 16
}

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


Syntax Highlighting

You can add a fenced code block by placing triple backticks ``` before and after the code block. For example:

```
pre {
  background-color: #f4f4f4;
  max-width: 100%;
  overflow: auto;
}
```

Will produce the following gray look:

Maxima Ghost Theme Syntax Highlighting

To highlight a code block. Add the language alias like css or js to the code block. For example, the CSS code in the previous example will wrap between ```css and ``` as follows:

```css
pre {
  background-color: #f4f4f4;
  max-width: 100%;
  overflow: auto;
}
```

Will produce the following colored look:

Maxima Ghost Theme Syntax Highlighting with prismjs

To add an inline code, you can wrap the text between two backticks ` `, for example:

This inline code example `absolute="true"`

Will produce the following look:

Maxima Ghost Theme Syntax Highlighting with prismjs


Maxima shipped with Prism.js, a lightweight, robust, and elegant syntax highlighter.

The initial Prism package includes some languages like Markup, CSS, C-like, and JavaScript.

You can add and support more languages. For example, to add support for PHP:

Get the PHP component script from Prism CDN.

<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.13.0/components/prism-php.js"></script>

Add the script to Ghost Code Injection Site Footer section. Click the Save button.

Maxima Ghost Theme Syntax Highlighting Code Injection PHP Prism


Google Analytics

To integrate Google Analytics, I would recommend using Google Analytics integration by Ghost.


Responsive Tables

Responsive tables are required and essential for adding tabular content and allows tables to be scrolled horizontally. You can make any table responsive across all viewports by wrapping a table with .responsive-table, for example:

<div class='responsive-table'>
  <table>
    ...
  </table>
</div>

Social Sharing Icons

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


Social Media Icons

Social media links placed in the partials/footer.hbs file.

The Ghost CMS supports adding Facebook and Twitter profile URLs from the admin panel. Go to General > Social accounts and add your URLs. This will update Facebook and Twitter URLs within the footer social media section.

social-accounts

For using other social accounts, the theme is using Evil Icons to provide 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>

Update Favicon

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

Update Ghost CMS favicon


Theme Translation

Maxima 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.

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

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

For example, the Germany translation file will look like:

{
  "Next": "Weiter",
  "Previous": "Zurück",
  " (Page %)": " (Seite %)",
  "Page Not Found": "Seite nicht gefunden",
  "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}",

  "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 consists of a left key ("Next") and the right value ("Weiter").

The key is plain English which exists 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 adding a new language. Please let me know.


Theme Deploy with GitHub Actions

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

Maxima 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 makes 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. Check My Current Setup.

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 produce 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.


My Current Setup

In case you are wondering what my current environment set up is. The packages version I use, check the following.

$ node -v
v10.16.0

$ npm -v
6.14.8

$ bower -v
1.8.8

$ gulp -v
CLI version: 2.2.0
Local version: 4.0.2

This environment works well for running Ghost and also for theme development.

I’m using macOS.


Code Injection

Another choice 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 and font size.

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

Zip Theme Files

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

zip -r maxima.zip maxima -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 choices:

  • 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