Penang Documentation

Current Version:1.2.4 — 22 March 2021 Changelog →

Theme Editing & Tools

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

Once you finish making your changes, zip the theme files, and upload the final zip file to your Ghost website.

If you are looking for Ghost hosting, I recommend Ghost(Pro) ↗.

Watch the following short video tutorial about theme editing.

Theme Installation
Upload the routes.yaml File (⚑ Required)
Create a New Content API Key (⚑ Required)
Members / Subscriptions
- Edit Plan Features
- Members / Subscription Theme Files
- Remove ‘Log In’ and ‘Subscribe’ from Header
- Remove the ‘Public’, ‘Members’ and ‘Paid’ Labels from a Post
- Embed the Subscribe Form in the Middle of a Blog Post
- Membership Troubleshooting Tips
Dark Mode
- Disable Dark Mode
- Disable Light Mode
- Remove the Header Dark Mode Switch Button
- Add Different Logo Images for Light and Dark Modes
- Add Different Hero Image for Light and Dark Modes
Navigation
- Secondary Navigation
- Home Tags Navigation
Home Hero
Search
- ghostHunter Slow Search
Pages
- Tags Page
- Authors Page
- Contact Page
Comments
- Disqus
- CommentBox
- Commento
Home Page Posts by Tag
Home Page Authors
Posts Per Page
Related Posts
Google Analytics
Update Favicon
Responsive Tables
Social Sharing Icons
Footer Social Media Icons
Languages
- Theme Translation
- Add a New Language
- Edit a Translation
- RTL
Syntax Highlighting
- Prism
Theme Deploy with GitHub Actions
Theme Development
- Code Injection
- Changing Colors with CSS Variables
- Customize Images Height
- Customize Logo Size
- Change Style Depending on the Screen Width
- Three Columns Layout Display for Home Posts
- Open Post Links in a New Tab
- Add Reading Time
- Show Full Post Excerpt for Post Cards
- Changing Theme Font
- Loading Custom Font
- Zip Theme Files
Theme Update

Theme Installation

The first step is to unzip the downloaded package. Inside the new directory penang, you will find the zipped theme and a documentation file.

Follow these steps to upload the theme to your website:

Log in to your Ghost website admin (example.com/ghost).
Click the settings icon ( ) at the bottom of the left hand side.
Go to Themes.
Scroll down to the INSTALLED THEMES section.
Click Upload a theme.
Select the theme file (penang.zip).
Once uploaded, click Activate now to activate the theme immediately. If you want to activate it later, click Close.

Upload the routes.yaml File (⚑ Required)

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

To upload the file, follow these steps:

Unzip the penang.zip theme file.
Go to the Labs page in Ghost admin (/#/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 folder.

Note: upload routes.yaml after uploading the theme zip

There will already be a default routes.yaml file uploaded to Ghost. You need to upload your theme’s routes.yaml to override the default.

Do this separately after uploading your theme zip file.

Create a New Content API Key (⚑ Required)

To enable certain features, like Search, you’ll need to create a new Content API Key. Follow these steps to create your key.

In the left-side menu of your Ghost admin, click Integrations then + Add custom integration.

Give the new integration a name, like “Search”, and click Create.

A new content API Key will be created. When you hover over it, a Copy button will appear. Click the button to copy the key to the clipboard.

Next, click Code injection from the left-side admin menu.

After replacing the API_KEY value with your API Key, add the following code to the Site Header box:

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

It should look like this:

Click Save.

Members / Subscriptions

Make sure to Upload the routes.yaml file.

Penang has different user interface elements for membership feature.

Login In and Subscribe buttons in the header
Footer and Hero subscription forms
A post subscription form
If the post is set to Members Only, a Call to Action section on the Post page to encourage visitors to subscribe

Edit Plan Features

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

Members / Subscriptions Theme Files

To edit the /subscribe/ page, you can edit the members/subscribe.hbs file.

The members/signin.hbs file for the /signin/ page.

The members/account.hbs file for the /account/ page.

To remove Log in and Subscribe from the header, open the partials/header.hbs file and remove lines 19 to 25. This will also remove the Account and Log out links.

Remove ‘Public’, ‘Members’ and ‘Paid’ Labels from Post Card

Open the partials/post-card.hbs file and remove lines 28 to 34.

Once you finish, zip the theme files, and upload the final zip file to your Ghost website.

Or, copy and paste the following CSS code into the Ghost admin Code Injection Site Header.

<style>
  .c-post-card__visibility { display: none; }
</style>

To add the Subscribe Form in the middle of a blog post, click on the + button and choose the HTML card.

Then paste the following code into the editor field and save your post.

<form data-members-form="subscribe" class="c-subscribe-form">
  <div class="form-group">
    <label for="subscribe-email-footer" class="u-hidden-visually">Your email address</label>
    <input type="email" name="email" class="c-subscribe-form__input" id="subscribe-email-footer" placeholder="Your email address" data-members-email="">
    <button type="submit" value="Subscribe" class="c-btn c-btn--action c-subscribe-form__btn">Subscribe</button>
  </div>

  <div class="u-alert u-alert--success u-mt-16">Please check your inbox and click the link to confirm your subscription.</div>
  <div class="u-alert u-alert--invalid u-mt-16">Please enter a valid email address!</div>
  <div class="u-alert u-alert--error u-mt-16">An error occurred, please try again later.</div>
</form>

You may be asking, how I got the form HTML code above? Well, you can copy it from your blog or the theme demo source code. You can do this by opening your browser DevTools and select the form element and copy it. Like the following screenshot.

You can use Chrome DevTools or Firefox Developer Tools. To open the DevTools, right-click on an element on the page and choose Inspect, then the Elements panel will open. Also, you can press Command+Option+C (Mac) or Control+Shift+C (Windows, Linux, Chrome OS) to open the Elements panel.

Membership Troubleshooting Tips

If for any reason the subscribe form does not work, or there is an error message, the following tips might help:

If you are self-hosting your website, make sure to set up the mail config ↗. After doing that, restart your Ghost server.
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 ↗.

Dark Mode

The dark mode is automatically activated based on the Operating System mode. Also, the user can switch between dark and light mode from the header button.

Disable Dark Mode

To disable Dark Mode, do the following steps.

Make sure that you run the Theme Development mode.
After you run gulp, open the assets/sass/settings/__all.scss file and remove line 8 (@import 'colors-dark';)
Remove the Header Dark Mode Switch Button

Another solution to disable the dark mode is to insert this CSS code into the Ghost admin Code Injection (Site Header) section.

Disable Light Mode

To disable the Light Mode and make Dark Mode the default, do the following steps.

Make sure that you run the Theme Development mode.
After you run gulp, open the assets/sass/settings/__all.scss file and remove line 7 (@import 'colors';)
Open the assets/sass/settings/_colors-dark.scss file and replace the file content with the following code.

:root {
  --color-brand:   #e7131a;
  --color-white:   #FFFFFF;
  --color-dark:    #010101;
  --color-text:    #FFFFFF;
  --color-gray:    #E5EFF5;
  --color-error:   #CC3C64;
  --color-success: #1BA672;
  --color-border:  #383B40;

  --bg-color:        #111016;
  --bg-gray:         #18181d;
  --bg-white:        var(--color-white);
  --bg-transparent:  rgba(31, 32, 35, .7);

  --bg-code-block:     #F6F9FC;
  --bg-code-inline:    var(--bg-gray);
  --color-code-inline: var(--color-text);
  --bg-post-card:      var(--bg-gray);
  --bg-tag-list:       linear-gradient(to left, var(--bg-color), rgba(31, 32, 35, 0));
  --bg-gradient:       --bg-gray;
}

Remove the Header Dark Mode Switch Button

Remove the Header Dark Mode Switch Button

If you want to remove the header dark mode switch button. Open the partials/header.hbs file and remove lines from 28 to 33.

Add Different Logo Images for Light and Dark Modes

Add the Logo Files to the Theme

In your theme, add two different logo files inside the /assets folder, one for light mode and the other for the dark mode. Please name each file as follows:

light-logo.png to be visible for light mode.
dark-logo.png to be visible for dark mode.

Change header.hbs file

Open the partials/header.hbs theme file and replace lines from 4 to 12 with the following code snippet.

<a href='{{ @site.url }}' class='c-logo'>
  <span class='u-hidden-visually'>{{ @site.title }}</span>
</a>

Add Custom CSS Code

Using Ghost Code Injection admin tool, add the following CSS code to the Site Header section.

<style>
  :root {
    --logo-image: url('/assets/light-logo.png');
  }

  @media (prefers-color-scheme: dark) {
    :root:not([data-user-color-scheme]) {
      --logo-image: url('/assets/dark-logo.png');
    }
  }

  [data-user-color-scheme='dark'] {
    --logo-image: url('/assets/dark-logo.png');
  }

  .c-logo {
    width: 40px;
    height: 40px;
    display: block;
    background-size: contain;
    background-position: center;
    background-repeat: no-repeat;
    background-image: var(--logo-image);
  }
</style>

Note

You might want to change the logo width and height by changing the value of 40px to match your logo preference and to get the best result.
If the logo image has a large white space around it, trim that space with a photo editing app for better results.
You will probably need to remove the browser cache for things to take effect.
This way will ignore the logo uploaded from the Ghost admin and the theme now will use the logos located in the theme.

Add Different Hero Image for Light and Dark Modes

#####Add the Image Files to the Theme

In your theme, add two different image files inside the /assets folder, one for light mode and the other for the dark mode. Please name each file as follows:

light-hero.png to be visible for light mode.
dark-hero.png to be visible for dark mode.

Change hero.hbs file

Open the partials/hero.hbs theme file and replace lines from 15 to 19 with the following code snippet.

<div class='o-grid__col o-grid__col--4-4-s o-grid__col--2-4-m'>
  <div class='c-hero-image'></div>
</div>

Add Custom CSS Code

Using Ghost Code Injection admin tool, add the following CSS code to the Site Header section.

<style>
  :root {
    --hero-image: url('/assets/light-hero.png');
  }

  @media (prefers-color-scheme: dark) {
    :root:not([data-user-color-scheme]) {
      --hero-image: url('/assets/dark-hero.png');
    }
  }

  [data-user-color-scheme='dark'] {
    --hero-image: url('/assets/dark-hero.png');
  }

  .c-hero-image {
    max-width: 350px;
    height: 350px;
    background-size: contain;
    background-position: center;
    background-repeat: no-repeat;
    background-image: var(--hero-image);
  }
</style>

Note

You might want to change the image max-width and height by changing the value of 350px to match your image preference and to get the best result.
You will probably need to remove the browser cache for things to take effect.
This way will ignore the image uploaded from the Ghost admin and the theme now will use the images located in the theme.

You can add, edit, delete, and reorder menu links on your Ghost blog in the NAVIGATION section (Admin > Settings > Design).

To include a static page on your navigation menu, follow these steps.

First, type the page’s name as you’d like it appear on your menu in the label field.

Next, click on the item’s URL. The blog URL will already be auto-populated. Add the page slug after the final /. When you’re satisfied with your page configurations, click the blue Save button to add the page to the navigation menu.

Currently, the theme shows the Ghost Primary Navigation in both the header and footer.

To show the Secondary Navigation items in the footer section, open the theme partials/footer.hbs file and replace line 20 with the following line.

{{ navigation type='secondary' }}

That’s all you need to do.

The home tags navigation will automatically show all the blog tags in alphabetical order.

If you want to remove the tags navigation, open the index.hbs file and remove lines from 5 to 8.

If you want to only show specific tags, open the partials/index-tag-list.hbs and replace line 2 with the following line after replacing each TAG_SLUG with your tag Slug.

{{#get 'tags' limit='all' filter='slug:[TAG_SLUG, TAG_SLUG, TAG_SLUG]'}}

So, if you have tag slugs like tech-vc, design, coding, it should be like:

{{#get 'tags' limit='all' filter='slug:[tech-vc, design, coding]'}}

Note the Comma (,) separating each slug.

Note

If the tag is empty with no posts, it will not be visible. Add the tag to any post, and it will appear.

This way does not guarantee to get the same tags in the same order as you added the slugs. Probably a Ghost issue. Instead, use the following method.

In this method, we get each page separately. For example, to get the design and coding tags, the partials/index-tag-list.hbs will look like.

<div class='o-grid__col o-grid__col--full'>
  <div class='c-tags-list-wrap'>
    <ul class='c-tags-list o-plain-list dragscroll'>
      {{#get 'tags' filter='slug:[design]'}}
        {{#foreach tags}}
          <li><a href='{{ url }}'>{{ name }}</a></li>
        {{/foreach}}
      {{/get}}

      {{#get 'tags' filter='slug:[coding]'}}
        {{#foreach tags}}
          <li><a href='{{ url }}'>{{ name }}</a></li>
        {{/foreach}}
      {{/get}}
    </ul>
  </div>
</div>

Home Hero

The hero section shows the site Publication cover and the site description. You can edit them from the Ghost admin General settings admin page.

For Publication cover:

Settings > General > PUBLICATION IDENTITY > Publication cover

For site description:

Settings > General > PUBLICATION INFO > Title & description

You can add normal HTML tags to the description like links or headings. The theme will automatically render them on the browser. For example, the demo description is the following:

<h3>Hello, <br>I'm Penang </h3><p>Create a subscription Ghost blog with a beautiful & minimalist design.</p>

Remove Home Hero Section

If you want to completely remove the Hero section, open index.hbs file and remove line 4 {{> hero }}.

Search

Make sure to create a new Content API Key.

The theme uses ghostHunter.

The search goes through the Post title and the content. It supports only Posts, not Pages.

The supported languages are German, Spanish, French, Portuguese, Italian, Finnish, Dutch, Turkish, and Danish.

ghostHunter Slow Search

If you have a large amount of content on your website, the search might become slow.

The issue is that Ghost does not have a built-in search feature ↗ so, to solve this and add search, a third-party library is used. In this case, the ghostHunter ↗ library.

This solution works well for most websites, but if the content is too large, it becomes a bit slow as the search happens on the user browser side, and all the data will be loaded before the search is happening.

There are currently two solutions:

1. Search only on the post title and ignore the content

This will improve search performance and reduce the loaded content. If this sounds fine, download this app.min.js ↗ file and replace it with your theme assets/js/app.min.js.

For reference, what I did was removing the post text from the request API in the assets/js/ghosthunter.js theme file. So line 108 becomes the following.

var url = site_url + "/ghost/api/v4/content/posts/?key=" + search_api_key + "&limit=all&fields=id,title,url,published_at,feature_image";

Instead of.

var url = site_url + "/ghost/api/v4/content/posts/?key=" + search_api_key + "&limit=all&fields=id,title,url,published_at,feature_image&formats=plaintext";

This is done in the theme development mode to generate the final app.min.js file loaded in the theme.

2. Using another search tool

Use another tool like Google Search, Elasticsearch, or Algolia. I have not tried them out, but here are a few resources at Ghost ↗.

Pages

Manage pages for Tags, Authors, and Contact from the Pages section of Ghost admin.

Tags Page

Follow these steps to create the Tags page:

From the Ghost admin Pages section, create a new page and give it a title, like “Tags”.
From Page settings, select the Tags template.
Publish the page.
To add the page to the navigation, please check the Navigation section above.

Note for Self-hosters

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

Authors Page

To create the Authors page:

Create a new page and give it a title, like “Authors”.
From Page settings, select the Authors template.
Publish the page
To add the page to the navigation, please check the Navigation section above

Note for Self-hosters

If you are self-hosting your website, you may need to do a server restart. This should get the Authors option to show up in the Template dropdown.

Contact Page

To create the Contact page:

Create a new Page and give it a title, like “Contact”.
Add your content and the contact form code using Formspree ↗ as a service. Please check the code example below.
Publish the page.
To add the page to the navigation, please check the Navigation section above.

<form action="https://formspree.io/your@email.com" method="POST">
  <input type="text" name="name" placeholder="Name">
  <input type="email" name="_replyto" placeholder="Email">
  <textarea name='message' placeholder="Message"></textarea>
  <input class='c-btn' type="submit" value="Send">
</form>

For more information, check out How to Add a Contact Form to Your Ghost Blog.

Comments

The theme supports comments from Disqus, Commento and CommentBox.

If you display comments for logged in users only, they will need to login/register into the comment system again. As you know, Ghost has no comment system, and these are third-party tools that are not integrated with and not part of Ghost.

For questions or issues about the commenting systems here, please contact their authors or check out their documentation.

Disqus

To enable Disqus ↗ as a comments system, open the partials/disqus.hbs file. Replace the aspirethemes-demos value with 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';

Once you finish, zip the theme files, and upload the final zip file to your Ghost website.

From the theme side, that’s all you need to set up Disqus. If you have any issues with comments not loading, make sure you have registered your website with Disqus (Step 1) ↗.

If you still have issues, check the Disqus troubleshooting guide ↗.

Disable Disqus

To disable Disqus comments, open the post.hbs theme file and comment or delete the line containing the {{> disqus}} text (line 29).

Once you finish, zip the theme files, and upload the final zip file to your Ghost website.

Disable Disqus Recommendations

Checkout the Disqus Recommendations ↗ documentation.

If you have any issue with Disqus redirecting to any advertising pages, please disabled Tracking and Affiliate Links from your Disqus account.

Check out Keegan Leary’s blog post about this issue at https://keeganleary.com/disqus-is-evil-trash/ ↗.

Also, be aware of Disqus trackings. Check out https://supunkavinda.blog/disqus ↗.

So, you might want to use another commenting system.

Thanks for sharing, Keegan!

Autoload Disqus

If you want to autoload Disqus without clicking the Comments button, open the partials/disqus.hbs file and replace the file content with the following code.

<div id='disqus_thread'></div>
<script>
  var disqus_shortname = 'aspirethemes-demos'; // required: replace `aspirethemes-demos` with your Disqus shortname

  // DON'T EDIT BELOW THIS LINE
  var disqus_config = function () {
    this.page.url ='{{url absolute="true"}}'
    this.page.identifier = 'ghost-{{comment_id}}';
  };

  var d = document, s = d.createElement('script');

  s.src = 'https://' + disqus_shortname + '.disqus.com/embed.js';

  s.setAttribute('data-timestamp', +new Date());
  (d.head || d.body).appendChild(s);
</script>

CommentBox

To enable CommentBox ↗ as a comments system, open post.hbs file and replace line 29 replace with {{> commentbox}}.

The next step is to create a CommentBox account. From the dashboard, create a new project by filling your site information. You will then receive a Project ID.

Copy that Project ID, open the partials/commentbox.hbs file, and replace the my-project-id value with it. That’s it.

Commento

To enable Commento ↗ as a comments system, open the post.hbs file and replace line 29 with {{> commento}}.

The next step is to create a Commento account and register your domain ↗ with it.

Home Page Posts by Tag

With this feature, you can show posts at the home page by a specific tag. To do this, open the partials/index-tag-columns.hbs file and you fill find 3 code blocks, everyone looks like the following screenshot:

They are already configured with some tags but you will need to change them according to your own existed tags.

Tag slug
Tag slug
Tag Name

Home Page Authors

The home page Authors section shows 3 authors ordered by posts count.

To remove this section, open the index.hbs file and remove line 26 ({{> index-authors }}).

Posts Per Page

You can control how many posts display per page from the package.json file.

"config": {
  "posts_per_page": 12
}

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

If other posts share the same tags, related posts will be visible at the bottom of a post.

Google Analytics

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

Update Favicon

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

Responsive Tables

Responsive tables are required and essential for adding tabular content and allowing 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>

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

Footer social media links are placed in the partials/social-icons.hbs file.

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

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

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

Odnoklassniki

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

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

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

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

Youtube

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

As mentioned above, Ghosts supports adding only Twitter and Facebook links from the admin. But the theme comes with other social icons in the sidebar. Edit or update these in the partials/sidebar-social-icons.hbs file. For example, here’s the Instagram code block:

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

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

Next, replace your Instagram full URL with the link href value. If your Instagram URL is:

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

Then the new code will be:

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

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

Languages

Penang ships with many languages already. But if you’d like to add another one, you’ll be able to do that too.

Theme Translation

Krabi supports Ghost i18n and comes with Arabic, German, Italian, Spanish, French Finnish, Portuguese Dutch, Turkish and Danish translations.

To use a language other than English, go to Admin > General > PUBLICATION INFO > Publication Language and enter the ISO Code.

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

Add a New Language

To add a new language, follow these steps.

Create a new file in the theme’s locales folder with the language ISO Code ↗ code. So, if the new language is 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 (ar in this example).

Edit a Translation

To improve or edit a translation in a specific available language, you can open the language file in the locales folder:

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

For example, the German translation file looks like this:

{
  "Loading": "Wird geladen",
  "More Posts": "Weitere Artikel",

  "Recent Posts": "kürzliche Artikel",
  "Featured Post": "Featured Artikel",
  "Page Not Found": "Seite nicht gefunden",
  "Load Comments": "Bemerkungen",
  "You might also like": "Das könnte Sie auch interessieren:",
  "Tags": "Stichworte",
  "Authors": "Autoren",
  "Navigation": "Navigation",
  "Published with {ghostLink} & {themeLink}": "Veröffentlicht mit {ghostLink} & {themeLink}",

  "Share on Twitter": "Auf Twitter teilen",
  "Share on Facebook": "Auf Facebook teilen",
  "Share on LinkedIn": "Auf LinkedIn teilen",
  "Share on Pinterest": "Auf Pinterest teilen",
  "Share via Email": "Per E-Mail teilen",
  "Copy link": "Link kopieren",
  "Link copied to clipboard": "Link in die Zwischenablage kopiert",

  "Search": "Suche",
  "Search {siteTitle}": "Suche {siteTitle}",
  "Type to Search": "Suchbegriff(e) eingeben",
  "Enable dark mode": "Schakel de donkere modus in",

  "Paid": "Bezahlt",
  "Members": "Mitglieder",
  "Public": "Öffentlichkeit",

  "Account": "Konto",
  "Log in": "Einloggen",
  "Log out": "Ausloggen",
  "Continue": "Fortsetzen",
  "Subscribe": "Abonnieren",
  "Subscribe Now": "Abonniere jetzt",
  "Your email address": "Deine E-Mail-Adresse",
  "Please check your inbox and click the link to complete the login.": "Bitte überprüfen Sie Ihren Posteingang und klicken Sie auf den Link, um die Anmeldung abzuschließen.",
  "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.",

  "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",
  "This page is for paying subscribers only": "Diese Seite ist nur für zahlende Abonnenten",
  "This page is for subscribers only": "Dieser Seite ist nur für Abonnenten",

  "Join the newsletter to receive the latest updates in your inbox.": "Treten Sie dem Newsletter bei, um die neuesten Updates in Ihrem Posteingang zu erhalten",

  "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.",
  "Subscribe to {siteTitle}": "Abonnieren bei {siteTitle}",
  "Choose this plan": "Wählen Sie diesen Plan",
  "Monthly": "Monatlich",
  "Yearly": "Jährlich",
  "month": "Monat",
  "year": "Jahr",

  "Welcome back!": "Willkommen zurück!",
  "Log in to 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!",
  "Your subscription will expire on": "Ihr Abonnement läuft am ab",
  "Your plan": "Dein Plan",
  "Card": "Karte",
  "Expires": "Läuft ab",
  "Next bill date": "Nächstes Rechnungsdatum",
  "Edit billing info": "ERechnungsinformationen bearbeiten",
  "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 ("More Posts") and a right value ("Mehr Artikel").

The key is plain English that exists in all translation files and should not be changed. You should change only the value.

If you have any suggestions to improve a current translation or add a new language, please contact me.

RTL

RTL means right to left. Turning on RTL makes the theme readable for languages written from right to left, like Arabic or Hebrew.

To enable the RTL option, open the default.hbs file and change line 10 to {{> compiled/inline-css-rtl }}.

Save the file and upload the theme to your Ghost blog.

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:

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;
}
```

This will produce the following colored look:

To add inline code, wrap the text between two backticks ` `.

Prism

Penang ships 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 support for 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>

From the side admin menu, go to Code Injection and add the script to the Site Footer section. Be sure to click Save.

Theme Deploy with GitHub Actions

Penang comes integrated with the Deploy Ghost Theme ↗ Github action.

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

The Deploy Ghost Theme action is developed by Ghost and works with any Ghost install whether you self-host Ghost or using Ghost Pro.

Theme Development

If you are a developer and need to do heavy customization work, the theme uses 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 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.

This file is generated from many other JavaScript files listed in the gulpfile.js file. Gulp will do all the work to create that file, so no manual work is needed.

Gulp will watch your changes in the assets/js/app.js or assets/js/ghosthunter.js (if exist) and will then generate the final app.min.js file.

➋ partials/compiled/inline-css.hbs: The final CSS file.

This file is generated from the assets/css/style-min.css file, which was generated by Gulp. It is used as an Internal CSS in the theme partials/head.hbs.

If you are working with Gulp, it’s recommended you avoid editing these files. Instead, do customizations in assets/sass for CSS or in assets/js/app.js JavaScript. This way, you can make sure the flow is going in the right direction and never lose any changes.

My Current Setup

In case you are wondering what my current environment set up is and which package versions I use, take a look at 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 use macOS Big Sur.

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 in the Site Header section to change the logo color and font size.

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

Watch the following short video about Ghost Code Injection, how it works, and how to use it.

Changing Colors with CSS Variables

Using Code Injection, you can change the theme colors for the light and dark modes with CSS Variables.

For a list of available theme variables, check:

Light theme: assets/sass/settings/colors.scss
Dark theme: assets/sass/settings/colors-dark.scss

If you want for example to change the theme brand color. You can copy the color variable and add it inside each code block like the following example.

<style>
  :root {
    --color-brand: red;
  }

  @media (prefers-color-scheme: dark) {
    :root:not([data-user-color-scheme]) {
      --color-brand: green;
    }
  }

  [data-user-color-scheme='dark'] {
    --color-brand: green;
  }
</style>

Notice that we duplicated the variable for dark mode in two blocks.

The color brand is used for buttons, links color, and links hover. In the above example, we changed the color for the light mode to be red and to green for the dark mode. You can override this for any other variable.

If, for example, you want to add another color that is not available in the available theme variables and wants to add another style to a new element. You can create a new variable and give it a name and value.

We can extend the previous example to add a new color for the logo color and assign that variable to the .c-logo__link class.

<style>
  :root {
    --color-brand: red;
    --color-logo: blue;
  }

  @media (prefers-color-scheme: dark) {
    :root:not([data-user-color-scheme]) {
      --color-brand: green;
      --color-logo: gold;
    }
  }

  [data-user-color-scheme='dark'] {
    --color-brand: green;
    --color-logo: gold;
  }

  .c-logo__link {
    color: var(--color-logo);
  }
</style>

The logo will then have a blue color for the light mode and gold color for the dark mode.

Customize Images Height

If you want to customize the height of the images on the home page and on the post page, you can use the following CSS code.

For the single post image. The theme default value is 56.25%. You can change this value to match your preference.

.c-post-image-wrap:after {
  padding-bottom: 56.25%;
}

For the homepage cards. The theme default value is 75%.

.c-post-card__image-wrap {
  padding-top: 75%;
}

The full code in Code Injection would be:

<style>
  .c-post-image-wrap:after {
    padding-bottom: 56.25%;
  }

  .c-post-card__image-wrap {
    padding-top: 75%;
  }
</style>

Customize Logo Size

If you are using an image as a logo (instead of the site name) and want to change the logo size, use the following code in Code Injection.

<style>
  .c-logo__img {
    max-height: 32px;
  }
</style>

The default value is 32px, so you can increase this value to match your preference.

If the logo image has a large white space around it, trim that space with a photo editing app for better results.

Change Style Depending on the Screen Width

To change the style of any element depending on the screen size the thme provides 3 stages, the initial/mobile size, the medium size, and the large size. For examplle, if you want to change the color of the post title on the three different stages, use the following code.

<style>
  .c-post-header__title {
    color: gray;
  }

  @media (min-width: 40em) {
    .c-post-header__title {
      color: red;
    }
  }

  @media (min-width: 64em) {
    .c-post-header__title {
      color: green;
    }
  }
</style>

The title will start with gray on the mobile size, red on medium and green on large screens.

Three Columns Layout Display for Home Posts

Open the partials/post-card.hbs file and replace line one with the following code line.

<div class='js-grid__col o-grid__col o-grid__col--initial-grow o-grid__col--4-4-s o-grid__col--2-4-m o-grid__col--1-3-l js-post-card-wrap c-post-card-wrap {{ post_class }}'>

The result will look like this:

If you want one column, use the following code.

<div class='js-grid__col o-grid__col o-grid__col--initial-grow o-grid__col--4-4-s js-post-card-wrap c-post-card-wrap {{ post_class }}'>

Open Post Links in a New Tab

To open the post links in a new tab, add the following script in the Code Injection Site Footer section.

<script>
  document.querySelectorAll('.c-post a').forEach(function (e) {
    if (e.hostname !== window.location.hostname) {
      e.target = '_blank';
    }
  });
</script>

Thanks Taylor.N for sharing this snippet!

Add Reading Time

There are two places you can add the post reading time, the article page and the postcard in the homepage and other listing pages.

To add reading time on the article page under the title, open the partials/post-header.hbs file and add the following line of code under the line42.

<span class='c-post-header__date'>{{ reading_time minute=(t '1 min read') minutes=(t '% min read') }}</span>

To add it in the homepage post card above the title area, open the partials/post-card.hbs file and add the following line of code under the line 26.

<span class='c-post-card__date'>{{ reading_time minute=(t '1 min read') minutes=(t '% min read') }}</span>

To learn more about how the reading time helper works, check out the Ghost documentation.

Add Reading Time

There are two places you can add the post reading time, the article page and the postcard in the homepage and other listing pages.

To add reading time on the article page under the title, open the partials/post-header.hbs file and add the following line of code under the line42.

<span class='c-post-header__date'>{{ reading_time minute=(t '1 min read') minutes=(t '% min read') }}</span>

To add it in the homepage post card above the title area, open the partials/post-card.hbs file and add the following line of code under the line 26.

<span class='c-post-card__date'>{{ reading_time minute=(t '1 min read') minutes=(t '% min read') }}</span>

To learn more about how the reading time helper works, check out the Ghost documentation.

Show Full Post Excerpt for Post Cards

The theme uses the Ghost `excerpt to output the post excerpt under the homepage post title cards. It only shows two lines of it.

To display the full excerpt, add the following CSS snippet code into the Ghost admin Code Injection Site Header.

<style>
  .c-post-card__excerpt {
    display: block;
  }
</style>

Changing Theme Font

Penang is using two fonts:

Inter ↗ for the overall theme text
Crimson Text ↗ for the post content and post card excerpt

The theme loads both fonts using Google Fonts in the theme partials/fonts.hbs file.

Inter font is then assigned it to the body element along with other system fonts as a backup as the following example.

body {
  font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
}

Crimson Text is assigned to the post card excerpt as.

.c-post-card__excerpt {
  font-family: 'Crimson Text', Georgia, serif;
}

And for the content text elements as.

.c-content dl,
.c-content fieldset,
.c-content form,
.c-content ol,
.c-content p,
.c-content pre,
.c-content ul {
  font-family: 'Crimson Text', Georgia, serif;
}

To change to any other font, you need to include the font on your theme or using Code Injection Site Header if you are using Google Fonts, for example.

For example, if you want to use the Roboto font from Google Fonts. Your code in Code Injection might be like this.

<link href='https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;700&display=swap' rel='stylesheet'>

<style>
  body {
    font-family: 'Roboto', sans-serif;
  }
</style>

You need to change that to the buttons and input elements.

<style>
  .c-post-card__excerpt {
    font-family: 'Roboto', sans-serif;
  }
</style>

<style>
  .c-content dl,
  .c-content fieldset,
  .c-content form,
  .c-content ol,
  .c-content p,
  .c-content pre,
  .c-content ul {
    font-family: 'Roboto', sans-serif;
  }
</style>

You might find the following posts useful as well:

Loading Custom Font

I assume that you have the font files and the initial @font-face CSS code for loading the font. Something similar to the following code.

@font-face {
  font-family: 'Atyp';
  src: local('Atyp Text Regular'), local('Atyp-Text-Regular'),
    url('AtypText-Regular.woff2') format('woff2'),
    url('AtypText-Regular.woff') format('woff'),
    url('AtypText-Regular.ttf') format('truetype');
  font-weight: 400;
  font-style: normal;
}

➊ Create a new folder in the theme under /assets and name it fonts, for example, then copy your font files there.

➋ Once you finish, zip the theme files, and upload the final zip file to your Ghost website.

➌ In Ghost admin Code Injection, add your @font-face code with the new font files path wrapped in the <style> element.

<style>
@font-face {
  font-family: 'Atyp';
  src: local('/assets/fonts/Atyp Text Regular'), local('Atyp-Text-Regular'),
      url('/assets/fonts/AtypText-Regular.woff2') format('woff2'),
      url('/assets/fonts/AtypText-Regular.woff') format('woff'),
      url('/assets/fonts/AtypText-Regular.ttf') format('truetype');
  font-weight: 400;
  font-style: normal;
}
</style>

This should load the fonts. Then you can use the font and do your styling for the body and so on.

Zip Theme Files

To create a zip file after your theme changes, you can use one of the following options.

Use one of the first two options if you are on a Theme Development mode.

Using the command line

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

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

Using Gulp

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

Using your computer program

You can compress it as a standard folder just like you do with any other folder on your computer. If you are on Mac, right-click on it to view the context menu. Then, click the “Compress” option.

Theme Update

You may be wondering: how can I update my theme to the latest theme version?

There are two choices:

Keep your current theme and replace only the changed files from the new version. You can find the modified files on the theme page Changelog
Use the latest version as a starting point and redo your theme changes and customizations

One way to reduce the need for redoing customizations is to use the Code Injection tool. This is very helpful for adding custom CSS and tracking code. Keeping your custom CSS code with Code Injection is always recommended.

Your feedback is very welcome ♥

I'm open to your feedback and to hear about your experience. If you have about one minute, please send your thoughts through this Google Form ↗.

Thank you for your time!

Theme Editing & Tools

Table of Contents

Theme Installation

Upload the routes.yaml File (⚑ Required)

Note: upload routes.yaml after uploading the theme zip

Create a New Content API Key (⚑ Required)

Members / Subscriptions

Edit Plan Features

Members / Subscriptions Theme Files

Remove ‘Log in’ and ‘Subscribe’ from Header

Remove ‘Public’, ‘Members’ and ‘Paid’ Labels from Post Card

Embed the Subscribe Form in the Middle of a Blog Post

Membership Troubleshooting Tips

Dark Mode

Disable Dark Mode

Disable Light Mode

Remove the Header Dark Mode Switch Button

Add Different Logo Images for Light and Dark Modes

Add the Logo Files to the Theme

Change header.hbs file

Add Custom CSS Code

Note

Add Different Hero Image for Light and Dark Modes

Change hero.hbs file

Add Custom CSS Code

Note

Navigation

Secondary Navigation

Home Tags Navigation

Note

Home Hero

Remove Home Hero Section

Search

ghostHunter Slow Search

1. Search only on the post title and ignore the content

2. Using another search tool

Pages

Tags Page

Note for Self-hosters

Authors Page

Note for Self-hosters

Contact Page

Comments

Disqus

Disable Disqus

Disable Disqus Recommendations

Autoload Disqus

CommentBox

Commento

Home Page Posts by Tag

Home Page Authors

Posts Per Page

Related Posts

Google Analytics

Update Favicon

Responsive Tables

Social Sharing Icons

Footer Social Media Icons

Languages

Theme Translation

Add a New Language

Edit a Translation

RTL

Syntax Highlighting

Prism

Theme Deploy with GitHub Actions

Theme Development

Note

My Current Setup

Code Injection

Changing Colors with CSS Variables

Customize Images Height

Customize Logo Size

Change Style Depending on the Screen Width

Three Columns Layout Display for Home Posts

Open Post Links in a New Tab

Add Reading Time

Add Reading Time

Show Full Post Excerpt for Post Cards

Changing Theme Font