Using the theme

To use the theme, at first extract the main downloaded zip file.

After extracting you will find a folder named similar to theme name. That folder is the production ready ( live site ready ) theme. After the required setup you will make a zip of this folder's content ( all files and folders within this folder ) and upload it to your ghost site.

To set up the theme properly with several setting options, please read through the documentation.

Please edit theme files using a proper code editor. There are lots of free and open source code editor available. You can choose any of those, some popular free code editor Visual Studio Code , Atom


Light and dark mode

This theme comes with light and dark mode. User can select dark or light mode as per their preference. This option let your user choose whether they prefer dark color or light color. User preference will be saved in their browser locally. Whenever they visit your site in future, they will see their preferred mode.

In site design settings options, there is an option to select to select default theme mode. There are three options for theme default mode.

  • System - detect user's system preference and set the mode accordingly.
  • Light - Set light theme mode.
  • Dark - Set dark theme mode.

You can choose one of these three options.

If you want to hide the theme switcher icon (sun/moon icon) in the navigation bar to prevent user to switch theme mode for themselves you can turn off Show theme mode switcher icon settings option.


Logo settings

This section describe instruction to setup image logo. If you do not use image logo then site title will be shown at the place of logo and you can skip this section.

As this theme has option to toggle dark and light mode. You have to provide, 2 different logo for 2 different mode.

I recommend to make your logos in svg format, but the format is not absolute requirement.

  • At first prepare 2 version of your logo ( each for dark background and light background ).
  • Go to ghost dashboard and then Settings > design.
  • Under brand section you will see the Publication logo option.
  • Upload the logo which is made for light background ( i.e. dark color logo for light background).
  • Now close the brand section and open Site-wide section. There is an option named Logo for dark mode.
  • Upload the second logo ( light logo for dark background ) there.

In this theme the stickiness of navigation 3 mode as follows.

  • Sticky hide: Navigation will hide on scroll as normal mode but as revers scroll start the navigation will be shown fixed on top of the page.
  • Sticky: Navigation will stick always on top of the page.
  • Normal: No sticky navigation.

By default the navigation is set to Sticky hide mode. You can change this in the site design setting. This option is under Site-wide section.

Choose Sticky-hide or Sticky or normal at the Navigation bar type setting option.


Intro section on home page

This theme comes with a custom intro section. Which shows a big heading and the site description on home page.

You can hide this section entirely or add or change the heading text from the dashboard under settings option.

Go to site design setting options and expand the homepage settings options section.

  • To hide the intro section entirely Turn off the Show home intro option.
  • Add any text in Home intro title option. It will be shown in as the title.
  • By default the Site description from brand section shown as the description in the intro section. You can override that by adding different text in the Home intro description override option text box.

On home page of this theme it shows 6 recent featured posts. So make your posts as featured and it will be shown there.

If you don't want to show featured posts then enable Hide featured posts section option in the homepage section under site design settings options.

If you want to change the maximum number of post in this section, do the following.

  • Open featured-posts.hbs file which is located in partials folder.
  • At line number 7 you will see the following code.
{{#get "posts" limit="6" include="tags,authors" filter="featured:true"}}

Change limit="6" in that line to the number of your choice.


At the footer of this theme Social links are being shown. To add your social links please follow the steps below.

From your ghost dashboard, Go to setting > general page. In social account option, you can add Facebook and Twitter link there. This Facebook and Twitter will be linked with the icons.

There is no option to add other social links directly from dashboard. Following are the steps to add other links.

  • open social-links.hbs file located in partials folder.
  • From line number 11, you can add different social links. Replace the # for each href value with your own profile links.
  • If you want to add other social links or want to remove one then copy or remove one of those lines. You can see all available icons in partials > icons folder.

The code in social-links.hbs file, where you will add your links, will look like below.

<a href="#" aria-label="instagram link">{{> icons/instagram}}</a>
<a href="#" aria-label="github link">{{> icons/github}}</a>

Normally you do not have to change the copyright text. But if you wan to change or edit the copyright text then follow the following steps.

  • Go to design setting option in your ghost dashboard.
  • Under Site-wide section you will see an option named Copyright text override.
  • Add any text there to override the default copyright text.

There are two navigation in Ghost. Primary and secondary. In this theme the primary navigation is shown in header and the secondary navigation is shown in footer.

By default In header (primary) navigation first 4 item will be shown directly and if there is more than 4 item in your primary navigation then those will be shown under a more dropdown item. It is handled by the theme. You have to do nothing for this.

But if you want to change the number of direct visible item in your primary navigation then you can do that by changing it in theme file.

  • Open navigation.hbs file which is located in partials folder.
  • At line number 6 you will see following code.
{{#foreach navigation to="4"}}
  • Change the number 4 to any number of your choice.

In Footer (secondary) navigation there are 3 columns. First column shows first 4 item, second column shows next 4 items and last column shows rest of the items.

Each column shows a small heading above the navigation items. If you need to change those heading you can change those in the theme file. You can change in language file en.json which is located in locales folder.

Find the following entries in that file.

"Features": "Features",
"Members": "Members",
"About": "About",

Change The right side words to the words you want to show. For example

"Features": "About Brand",

If you don't want to change the texts in language (en.json) file but want to change directly in theme's code. Then please follow the steps below.

  • Open navigation.hbs file located in the partials folder.
  • At line number 70 you will see the following code
<h3 class="title h6">{{t "Features"}}</h3>
  • Change the Word Features to your word, what you want to show there. Change words same way how you did above step at line number 87 and 104 for other 2 column.

If you want to change number of items in each column you can do this by changing limit and form value at line numbers 66, 83 and 100.


Membership subscription

If you are using paid membership feature then you are definitely going to create a membership page where you will show your pricing table.

Follow the steps below.

  • Create a normal page.
  • Give it a title and description.
  • From the page settings select Membership Page template.
  • Save the page.

This page will show all the visible pricing which you setup in the Membership setting option. Make sure to go to customize portal and check all the tires under Tiers available at signup option.


Installation

Ones the necessary configuration is done, make a zip of the modified theme folder.

Now login to your admin area and go to Settings > Themes. Near the end of the page you will find Upload a theme button. Upload the theme zip which you have created while ago. After finishing upload, activate the theme.

If you want to install the demo data to make your site as the preview then you can go to Settings > labs and then import the inros.ghost.demo.json file there. This file is located in demo data folder in main download folder.

Importing the demo document may miss images. In that case delete the missing images and upload your own images from dashboard.


Single post setting options

In this theme there are few option for single post. Go to Site design settings option and then expand Post section.

  • Disable Show share buttons to hide share buttons below the post content.
  • Disable Show author info card* to hide the author info card below the post content.
  • Disable Show related posts if you want to hide the related post section.

Disqus shortname option is required for Disqus comment. If you don't want to show comment option then just keep this option text box blank and comment will be disabled.

If you want to show the comment as the demo site and setup the Disqus comment then you need to put your disqus shortname in the above mentioned Disqus shortname option text box.

To setup and get the disqus shortname please follow the steps below.

  • Go to disqus.com and sign up.
  • After log in go to admin dashboard.
  • Then follow the instruction and add your website there.
  • At the time of adding your site you will get a disqus shortname, copy that.
  • Now put that shortname in the Disqus shortname option text box.

Settings in code injection

There is a setting option which you have to set in code injection. At first please copy and add the following code block in code injection Site Header box.

<script>
var apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
</script>
  • apiKey - This apiKey is needed for search functionality in the theme.
    • Go to your admin dashboard and visit "Integrations" setting page.
    • Click on the "Add custom integration" button.
    • Give it a name ( anything you want, it does not matter). You can just name it "search"
    • Save that and copy the "Content API key".
    • Now go to Settings > Code injection page and replace the placeholder API key xxxxxxxxxxxxxxxxxxxxxxxxxx with the actual API key.

API key for search


Code highlighting

Code highlighting is already implemented within this theme. This feature is not used by all user of the theme. It only used by technical writer who writes code example within their article.

This feature loads extra javascript code which is a waste of resources for those people who do not use this feature. That is why by default it is disable in this theme. Required css is already there. You just have to add a single line in code injection to load the javascript file.

Go to Settings > Code injection page in your dashboard and add the following line in the Site footer box( bottom box).

<script src="/assets/js/plugin/prism.js"></script>

Membership page

To create a membership (showcase pricing tables) page please follow steps below.

  • Create a new page.
  • Give it a title.
  • Add small description in the page content area to show it above the pricing table section.
  • Open page settings panel by clicking on the gear/cog icon at top right corner.
  • Scroll down in the settings panel and select Membership Page template for this page.
  • Publish this page and add the page link in your navigation.

Sign in and Sign up page

For your members you need a Sign in and a Sign up page. The links to these pages are already added in the theme but you have to create 2 page from the Ghost dashboard. Please follow the steps below.

  • Create a new page.
  • Give it a title ( anything you want, it will not be shown to your user).
  • Open page settings panel by clicking on the gear/cog icon at top right corner.
  • Make sure the page URL / slug is signin without any extra space or character.
  • Scroll down in the settings panel and select Sign in Page template for this page.
  • If you want to add an image you can do that by adding a feature image to the page.
  • Publish this page.

For sign up page follow the same steps as mentioned above but set page URL / slug to signup at step number 4. And at step number 5 select Sign up Page page template.


Author and tag archive

In this theme there are two custom template for Tag archive and Author Archive. These pages shows list of all tags and all archive respectively. To use those template please follow the steps below.

  • Create a new page.
  • Add a Title ( example: Authors or Authors Archive or any thing else you want).
  • Open page settings panel by clicking on the gear/cog icon at top right corner of the page.
  • Scroll down in the settings panel and select Author Archive Page template for this page.
  • Publish the page and add the page link in your navigation.
  • Save it and visit your site. If you did everything right then you will see your newly created link in your menu bar. Open to see all available author list.

For Tag archive page follow the same steps as author archive setting. At step 4 choose "Tag Archive Page"template option. Then Follow all the remaining steps and you will be able to add a tag archive page in you site.


Account page

For your logged in user you have to add an account page to show your member's account information. Please follow the steps below.

  • Create a new page.
  • Give it a title.
  • Open page settings panel by clicking on the gear/cog icon at top right corner.
  • Make sure the page URL / slug is account without any extra space or character.
  • Scroll down in the settings panel and select Account Page template for this page.
  • Publish this page.

If you are not using paid membership and just using free sign up and free members then you can use simple account page. For that select Account Simple Page template at step 5 above.


Yearly and monthly post archive

With this theme you can show an archive page which shows all the posts. There are 4 option for this page. You can setup which you want. The available options are as follows.

  • Yearly archive (show all post at once).
  • Monthly archive (show all post at once).
  • Yearly Archive (paginated).
  • Monthly Archive (paginated).

If you want to show yearly or monthly archive page which shows all post at once then follow the steps below.

  • Create a new page.
  • Open page settings panel by clicking on the gear/cog icon at top right corner.
  • Scroll down in the settings panel and select Archive Yearly Non Paginated or Archive Monthly Non Paginated template fot this page.
  • Publish this page and add the link to the navigation setting.

If you want to show yearly or monthly archive which shows posts paginated ( with the load more button) then you have to set up a custom route. Please follow the steps below.

  • First create a new page.
  • Make sure the URL of this page is set to archive.
  • By default it will show paginated yearly archive.If you want to show monthly archive instead then add #monthly internal tag to this page.
  • Save the file.
  • Now find the custom routes.yaml file which comes with this them.
  • Go to Settings > Labs in your dashboard.
  • At the end of the page you will find Routes option. Download your current routs.yaml file for backup and then upload the custom routes.yaml file which comes with the theme.

Contact form

In the demo of this theme you have seen a contact form. As ghost has no inbuilt feature for this you have to use a third party service. In demo formspree has been used.

If you want to add contact form in your site same as the demo, then follow this steps.

There is a file named contact-form-code.txt in the downloaded zip folder.

Copy the entire code from that file, now go to your page editor and then add the code using an HTML card. Change the example email address to your own email address within the code.


Theme translation

This theme supports translation. Please follow the steps below to translate this theme in your language.

  • Within theme folder, there is a folder named "locales". In that folder by default you will find a file named en.json. This is the default file for English language and you have to use this file to create your own language file.
  • make a copy of en.json and give a name following this format [language_code].json ( example: for French fr.json for German i.e. Deutsch de.json for Russian ru.json etc. )
  • If you are not sure about what is you language code then you can visit this wiki page and see. Use the two letter (ISO 639-1) code.
  • Now open the newly created <your_language>.json file in text editor. You will see "KEY": "VALUE" format in each line.
  • In English language KEY and VALUE are same. Now you read the left part of the : i.e. KEY part and change the tight part i.e. VALUE part to your own language.
  • After finishing the translation Save the file and upload the theme to your site.
  • Go to your admin area, Visit "General setting" page and change the "publication Language" option. By default there is "en" for English. Add your own language code there in place of "en" and save the settings.
  • Visit your site, If everything goes right, you will see all the theme related text in your site is in your translated language.

Theme customization

If you need to add only small CSS or just change colors then you can add using Ghost's Code Injection feature. In "Site Header" box you can add CSS. You can override the default colors, which are available as CSS custom properties (also knows ad CSS variables). See How to change color or CSS section below.

Detail customization prerequisite

This theme is built using Gulp to compile JavaScript and CSS. CSS is written in SCSS. So if you want to modify the theme's styles or appearance or anything you want to customize, before doing that you need to setup development environment setup.

Please follow all the steps below one by one to do it.

You need to have installed node js and gulp installed in your local machine.

  • If you don't have NodeJS installed in your machine then visit nodejs.org and download and install latest LTS version of NodeJS.
  • After installing NodeJS open a command prompt or terminal. Then type node -v. If it shows a version number then NodeJS is installed correctly. Also enter this command npm -v to see npm ( comes with node js) is installed properly.
  • After installing node js you need to install Gulp CLI globally in your machine. So in your terminal or command prompt enter this command. npm install gulp-cli -g. It may take some time, it will install Gulp CLI globally in your machine. Now you have done the environment setup.
  • At this point go to the development theme folder. In downloaded zip there is a folder named "development". Within that folder you will see a folder named as the theme name. Enter in that folder and run command prompt / terminal here. Or you can navigate to this folder within already running terminal.
  • Now enter command npm install. It may take some time. It will install all the development dependency within the project. It may show some warning, don't worry those are OK.
  • At this time you are ready to modify theme, Run one more command gulp in the terminal. It will initially compile all files and star to watch file changes. Keep the terminal open and start customizing the theme.

How to change color or CSS

If you just want to change the accent color for yours site you can directly do that from the Ghost dashboard.

  • Go to Settings > Branding in your dashboard and then change the accent color there.
  • Save the settings and your selected color will be reflect in your site.

If you do not want to setup development environment and just want to change other colors. Then you can override already available CSS custom properties (also knows ad CSS variables). See the available custom properties in the below code block.

:root {
--logo-header-height: 40px;
--logo-footer-height: 40px;
--c-white: #ffffff;
--c-black: #000000;
--c-success: #96EA8C;
--c-error: #FF9B84;
--c-star: #FFD700;
--c-button-text: var(--c-white);
--size-1: 4px;
--size-2: 8px;
--size-3: 16px;
--size-4: 24px;
--c-body-bg: #ffffff;
--c-text-main: #161F38;
--c-text-light: #575861;
--c-gray-light: #EFEFEF;
--c-gray-lighter: #f9f9f9;
--c-border: #DADCE5;
--c-border-light: var(--c-gray-light);
--shadow-opacity: 0.02;
--c-shadow: 0 15px 40px 5px rgba(132, 132, 133, 0.15);
}

Dark theme

[data-theme=dark] {
--c-theme: var(--ghost-accent-color);
--logo-header-height: 40px;
--logo-footer-height: 40px;
--c-white: #ffffff;
--c-black: #000000;
--c-success: #96EA8C;
--c-error: #FF9B84;
--c-button-text: var(--c-white);
--size-1: 4px;
--size-2: 8px;
--size-3: 16px;
--size-4: 24px;
--c-body-bg: #272935;
--c-text-main: #f9f9fa;
--c-text-light: #b2b2b3;
--c-gray-light: #454854;
--c-gray-lighter: #303340;
--c-border: #35394b;
--c-border-light: var(--c-gray-light);
--c-shadow: 0 10px 10px rgba(0, 0, 0, 0.2);
}

If you already setup or want to setup development environment and then want to modify the theme then read below.

In the theme folder you will find "assets > scss" folder which contains all the theme styles written in SCSS.

To change any style / css you need to modify here. In SCSS folder you will find a folder named "components" which contains a bunch of .scss files which are part of the whole theme's style. and all those files are imported in a specific order in "screen.scss" file located in "scss" folder root outside of "components" folder. please don't edit that file.

To change the Theme color please follow the steps below.

  • Open the _global-settings.scss file in your code editor.
  • Now you have to change the color hexcode (#xxxxxx) in this file and save the file.
  • If you have followed the above section of instruction ( Detail customization prerequisite), and already running terminal with the gulp command then the file changes will be detected and if there is no error in your file then it will be automatically compiled.

The _global-settings.scss file looks like below.

/*=====================================================
Fonts
=====================================================*/

:root {
--font-family: 'Roboto', sans-serif;
}
/*=====================================================
light theme colors ( as SCSS mixin )
=====================================================*/

@mixin theme-light {
--c-body-bg: #ffffff;
--c-text-main: #161F38;
--c-text-light: #575861;
--c-gray-light: #EFEFEF;
--c-gray-lighter: #f9f9f9;
--c-border: #DADCE5;
--c-border-light: var(--c-gray-light);
--c-shadow: 0 15px 40px 5px rgba(132, 132, 133, 0.15);
}
/*=====================================================
dark theme colors ( as SCSS mixin )
=====================================================*/

@mixin theme-dark {
--c-body-bg: #272935;
--c-text-main: #f9f9fa;
--c-text-light: #b2b2b3;
--c-gray-light: #454854;
--c-gray-lighter: #303340;
--c-border: #35394b;
--c-border-light: var(--c-gray-light);
--c-shadow: 0 10px 10px rgba(0, 0, 0, 0.2);
}
/*=====================================================
common variables ( as SCSS mixin )
define common variable for light and dark here
=====================================================*/

@mixin common-vars {
/* setting theme color to ghost accent color. By default we used #FF3A46 */
--c-theme: var(--ghost-accent-color);
--logo-header-height: 40px;
--logo-footer-height: 40px;
--c-white: #ffffff;
--c-black: #000000;
--c-success: #96EA8C;
--c-error: #FF9B84;
--c-button-text: var(--c-white);
--size-1: 4px;
--size-2: 8px;
--size-3: 16px;
--size-4: 24px;
}
/*=====================================================
⚠ WARNING: please do not edit below this line,
incorrect coding may break the theme

Merging common variables with light and dark
separately
=====================================================*/

:root {
@include common-vars;
@include theme-light;
}
[data-theme="dark"] {
@include common-vars;
@include theme-dark;
}

After modifying the theme css when you are done and want to install the final theme in your live site, do the following.

  • Go to running terminal ( terminal is navigated to development theme folder and running gulp command to watch the file changes )
  • Press Ctrl + C in your keyboard to end the running task.
  • After ending running task enter this command, gulp build. This command will build the production ready ( live site ready ) theme package within a folder named "build".
  • After doing the gulp build if you need you can configure the theme options ( such as pricing tables, social links etc ) then use this command gulp zip. It will make a folder named "dist" and make a zip of the contents of "build" folder within "dist" folder.
  • Now you can upload this newly created zip in your ghost admin panel.

Changelog

V 2.0.0 - May 24, 2022

  • Removed deprecated API in package.json
  • Removed deprecated helper
  • Removed Old pricing table
  • Removed tire benefits Inros helper.
  • Modified pricing table.

V 1.5.0 - April 27, 2022

  • Added pricing tire description to membership pricing table.

V 1.4.0 - April 26, 2022

  • Fixed id issue in comment.
  • Fixed theme color mode in sign in and sign up page.
  • Added support for membership tires.
  • Reduced margin in Sign in and sig up forms in small screen.
  • Removed deprecated API engine key from package.json file.

V 1.3.0 - December 24, 2021

  • Added support for all new cards available in the editor.
  • Added various custom settings so that those can be changed without editing theme files.
  • upgraded minimum required ghost version to 4.20.0.

V 1.2.0 - October 14, 2021

  • Improved CSS color and spacing consistency.
  • Fixed extra space on sign up and sign in page when nav set to sticky.

V 1.1.0 - October 07, 2021

  • Fixed and improved some minor CSS issue and style.
  • Added missing translations.

V 1.0.0 - September 25, 2021

  • Initial release