Mino Documentation

Using the theme

To use the theme 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 opensource code editor available. You can choose any of those, some popular free code editor Visual Studio Code , Atom

Theme option configuration

To configure this theme properly for your site please follow below instruction.

open config.hbs file located in partials folder with a plain text editor (like notepad, notepad++, Brackets editor, Sublime text etc.). Then replace the variable's value with your own values.

Set the disqus_shotrname value to your won Disqus shotrname. To generate a disqus shortname...
- Go to disqus.com and sign up.
- Then follow the instruction and add your website there from disqus.com dashboard.
- You will get a dishqus shortname, copy that.
- In config.hbs set disqus_shortname = 'yourDisqusShortnameHere';
Navbar setting
- set the fixed_navbar to either true or false for fixed navbar or normal navbar. default value is true for fixed navbar.
Configure The API KEY
- Go to your admin dashboard and visit "Integrations" setting page.
- Scroll Below and click on the "Add custom integration" Link.
- 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". Please see the image below.
- replace ADD-API-KEY-HERE with your API key which you have copied.
Configure the mailchimp signup form No need to change / configure this option if you are using Ghost version 2.0.0 or above and using ghost inbuilt subscriber feature. Keep it as it is, There will be no problem. following instruction is for user who want to use old mailchimp subscribe widget
- Create a list on mailchimp and generate a subscribe form. Then copy the form URL and set it to mailchimp_form_url = 'YourMailchimpSubscribeFormUrl';
  Remember to remove /post from the url. For better understanding compare to the default link provided.
- To generate form URL login to mailchimp. Go to list tab and open your list. Now Click on "signup forms" and then you will see 4 options for form type. Choose General forms. It will open the form builder.
- Copy the link in the "Signup form URL" field and then paste in a new tab in your browser. it will redirect to the form itself. Then copy the link from address bar and use this link.

The config.hbs file will look like below.

<script>
/*====================================================
    THEME SETTINGS & GLOBAL VARIABLES
====================================================*/
//  1. Disqus comment settings
var disqus_shortname = 'borsha-ghost-theme'; // required: replace example with your forum shortname

//  2. Fixed navbar
var fixed_navbar = true;

// 3. Content API key ( it required to search work)
var api_key = 'ADD-API-KEY-HERE';

//  4. Mailchimp signup form Setting
// No need to change if you are using Ghost version 2.0.0 or above and using ghost inbuilt subscriber feature
// Keep it as it is, there will be no problem
var mailchimp_form_url = 'http://gbjsolution.us4.list-manage.com/subscribe?u=a63b2fed3ed61b70bf56d1aed&id=1e3806b1d4';
var success_message = "Please check your inbox and confirm your email address. Thanks!";
</script>

Home page cover

In home page cover there is a heading and some description

You can change the description directly from Dashboard general settings. Change the site description there and it will be shown as description on home page.

To change the title on home page cover, please follow the steps below.

Open cover-home.hbs file which is located in partials folder within the theme folder.
Now At line number 4 you will see the default title. Change the title to your own text and save the file.

To add the actual social links to the icons in footer, please follow the steps below.

open social-links.hbs file located in partials folder.
Now replace the # for each href value with your own profile links.
If you want to add any other icon then just copy one of the line there and only replace the fa-* class in that line. For list of available icons in fontawesome visit here.
You don't need to change the RSS icon's link.

The social-links.hbs file will look like below.

<div class="social-links-wrap align-center">
    <ul class="social-links">
        <li><a href="#"><i class="fa fa-facebook"></i></a></li>
        <li><a href="#"><i class="fa fa-twitter"></i></a></li>
        <li><a href="#"><i class="fa fa-google-plus"></i></a></li>
        <li><a href="#"><i class="fa fa-dribbble"></i></a></li>
        <li><a href="#"><i class="fa fa-instagram"></i></a></li>
        <li><a href="#"><i class="fa fa-linkedin"></i></a></li>
        <li><a href="/rss/"><i class="fa fa-rss"></i></a></li>
    </ul>
</div>

The footer is widgetized. You can change the position or entirely remove any of theme if you wish. To do that you have to make very little changes in footer.hbs file which is located in partials folder.

All the widget files are separate in partials folder and named with prefix 'widget'. Example:- widget-newsletter.hbs

Please Follow the steps below.

Open footer.hbs file and then reorder the partials call.
To hide or remove any widget in sidebar just comment out that specific widget.
To comment out any widget you need to add a ! before > in that widget. Example:- If you want to hide {{> widget-text}} then add ! like this {{!> widget-text}}
Then save the file

Widgetize area in footer.hbs will look like this..

<div class="row footer-widget-area">
  <div class="col-md-4 widget-wrap">
    {{> widget-tagcloud}}
  </div>
  <div class="col-md-4 widget-wrap">
    {{> widget-recentpost}}
  </div>
  <div class="col-md-4 widget-wrap">
    {{> widget-newsletter}}
    {{> widget-text}}
  </div>
</div>

Installation

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

Now login to your admin area and go to Design. In that page scroll down and you can find "Upload a theme" button. Upload the theme zip which you have created while ago. After completing upload activate the theme.

If you want to install the demo data to make your site as the preview then you can go to your-site-url/ghost/settings/labs/ and then import the mino.ghost.demo.json file there. This file is located in demo data folder in main download folder.

To add links to you static page please follow the steps below.

Create a new page in your dashboard.
Copy the URL for this page from the page settings panel.
Go to Design page in your admin dashboard.
Add a label and the URL and save it.
Now the theme will show newly added link in navigation.

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.

If you translate the theme in any language, then please consider to share ( feel free to send me via email ) that language file. I will add that file to the theme, so that it will available to other users.

Featured Media in post

Ghost supports featured/cover image in post natively, and this theme handle that nicely. Recommended image size is, minimum 1030px X 560px.

If you want to add any embeded media like YouTube video, vimeo video, SoundCloud music or any other embeded iframe as featured media in your post then you have to wrap that in <featured>Your Embed code here...</featured> tag while writing the post. This embeded featured media will be shown at the place of cover image in full post view. Also set a cover image to display in homepage or other post listing page.

An example of YouTube video below...

<featured><iframe width="560" height="315" src="//www.youtube.com/embed/Uz2P2WdSzyo" frameborder="0" allowfullscreen></iframe></featured>

How to Change Color

To change the Theme color please follow the steps below.

First of all you need a LESS compiler. You can use koala app
Add the css folder of your theme (located in /assets/) to less compiler.
Open the variables.less file in your code editor. This file is located in assets/css/less_parts folder.
Now you have to change the color hexcode (#xxxxxx) in this file and save the file.
Now compile the screen.less file using less compiler. This file is located in assets/css folder. This will rebuild the screen.css file.
At last Update the files in your server and restart ghost.

The variables.less file looks like below.

/*====================================================
  COLOR VARIABLE FOR THEME
====================================================*/
@theme-color: #0dd0e7;        // Theme color
@text-color: #404040;       // Primary text color
@text-color-light: #a9a9a9;     // Light text color
@text-color-dark: #161616;      // Dark text color
@body-bg: #ececec;          // Body background color
@light-bg: #f5f5f5;         // Light background color
@border-color: #e4e4e4;       // Border color
@black: #000000;          // Pure black
@white: #FFFFFF;          // Pure White
/*====================================================
  font family
====================================================*/
@font-primary: 'Montserrat', sans-serif;
@font-secondary: 'Merriweather', serif;
/*====================================================
  social colors
====================================================*/
@facebook: #3b5998;
@twitter: #1da1f2;
@google-plus: #db4437;
@linkedin: #097bb5;
@pinterest: #cc2127;
@youtube: #b31217;
@vimeo: #1ab7ea;
@dribbble: #ea4c89;
@flickr: #ff0084;
@reddit: #ff4500;
@tumblr: #35465c;
@vk: #4c75a3;
@soundcloud: #ff5500;
@github: #4183c4;
@instagram: #3f729b;
@stumbleupon: #eb4924;
@stack-overflow: #fe7a15;
@stack-exchange: #205296;
@xing: #026466;
@skype: #00aff0;
@envelope: #e73d2f;
@rss: #f26522;

Changelog

V 2.2.0 - May 30, 2019

Added new helper @site.lang
Replaced deprecated @blog helper with @site helper
Added API v2 in package.json. Theme now uses API v2
Added CSS and js for image gallery
Replaced GhostHunter with fuse js
Re-written search function to use fuse js and API v2
Added new API Key settings in config.hbs

V 2.1.0 - August 26, 2018

Upgraded the theme to use with Ghost 2.0.0 and above. For older ghost version please use older version of the theme.
Removed cover-author.hbs file from partials folder. Added code of those file to author.hbs file.
Changed author helper in author.hbs to make it compatible with Ghost 2.0.0
Added Ghost's inbuilt subscribe support. New widget file is widget-subscribe.hbs
Renamed widget-newsletter.hbs file to widget-mailchimp.hbs. This file kept for old version users. By default this widget is not being used in new version of the theme.
Added Koenig Editor's Image card's different image widthe CSS class.
Added Koenig Editor's Embed card's support CSS.
Added translation support.
Added keyword "ghost-theme" in package.json file

V 2.0.0 - July 15, 2017

This version is a major update. It works with Ghost version >= 1.0.0. It will not work with older version of ghost ( ghost version < 1.0.0 ).
Removed favicon from default.hbs template. Ghost >= 1.0.0 automatically handle it. Upload publication icon from General setting page, in your dashboard.
Rewritten package.json to be compatible with ghost 1.0.0
Replaced all deprecated helpers and added new helpers in place of those old helpers.
jQuery library updated to v2.2.4

V 1.0.0 - November 19, 2016

Initial release

On this page

Using the theme

Theme option configuration

Home page cover

Footer widgets

Installation

Navigation links

Theme translation

Featured Media in post

How to Change Color

Changelog

V 2.2.0 - May 30, 2019

V 2.1.0 - August 26, 2018

V 2.0.0 - July 15, 2017

V 1.0.0 - November 19, 2016

Mino Documentation

On this page

Using the theme

Theme option configuration

Home page cover

Adding social links

Footer widgets

Installation

Navigation links

Theme translation

Featured Media in post

How to Change Color

Changelog

V 2.2.0 - May 30, 2019

V 2.1.0 - August 26, 2018

V 2.0.0 - July 15, 2017

V 1.0.0 - November 19, 2016