1. Introduction

Thank you! for buying one of our template, if you find any kind of issue or bug don't hesitate on contact us.

We will resolve your problem as soon as possible.

Template information:

Features

  • Full Koenig Editor Support.
  • Pre packaged with SASS (SCSS), Prepos 6 config file included.
  • Syntax Highlight see here.
  • Custom Subscribe Page see here..
  • Constantly updated.
  • Translation ready (English and Spanish Included).
  • Minified and Optimized code.
  • HTML5 & CSS3 ready.
  • Ghost 5.x compatible.
  • 2 Single post dispositions
  • Custom Tag page, see here.
  • Custom Author page, see here.
  • Custom 404 Page see here.
  • Search Widget.
  • Koening Gallery Support
  • Advertising sections.
  • Disqus Support.
  • Fully responsive.
  • Video Support (Vimeo, Youtube, etc).
  • Retina Display Ready.
  • Font Awesome icons.
  • Works on Android, Ipad and Iphone.
  • Documentation included.
  • Clean Design.
  • Well Coded.
  • Navigation Menu.

Requirements

Breek is a Ghost theme so the basic requirements are the same of Ghost

2. Theme Setup

2.1. Install the template

This guide assumes that you already have a Ghost installation ready.

Uploading the theme (v1.0 for Ghost 1.2.x and higher)

  • Log in into your Ghost admin panel.
  • Go to settings (design section) and upload "breek.zip"
  • Click Activate.

Uploading the theme on custom hosting (FTP)

The instructions are pretty simple:

  • Login on your FTP account.
  • Unzip the breek.zip file and copy breek folder to your /ghost_installation/content/themes
  • Restart your installation if neccesary. You can ask help to your hosting provider if you don't know how to do this step.
  • Login into your ghost admin panel.
  • Go to settings (general) and select theme "breek"
  • Click Save.

2.2. Activate Subscribe page (Ghost v3.0)

Note: For Ghost 4.0 and higher Members feature is enabled by default.

  • Go to Settings/Labs.
  • Check Enable Members
  • Click Save.

IMPORTANT: We highly recommend you to read the Full Guide about Membership and Subscribers: https://ghost.org/docs/members/introduction/

2.2.1 Create Required Pages for Members (Ghost 3.x and higher)

On Ghost v3.0 there is a new feature where visitors can subscribe to your Blog, this feature requires to create 4 pages:

Note: the most important is to create these pages with the next unique slugs: "account", "membership", "subscribe" and "signin", the title doesn't matter:

1.- A subscribe page (required): where all your visitors can register their emails. Ref: http://ghost.estudiopatagon.com/breek/subscribe/

2.- A Sign In page (required): where all your visitors can send login link to their emails. Ref: http://ghost.estudiopatagon.com/breek/signin/

3.- A Membership page (optional): if you are not going to publish paid articles, is totally optional. This page will display your Price Tables with free, monthly and yearly plans. In case you need to edit the tables, you must edit breek/partials/membership-plans.hbs file. Ref: http://ghost.estudiopatagon.com/breek/membership/

4.- An Account page (optional): if you are not going to publish paid articles, is totally optional. This page will display your customer subscription plans with some details and a cancel button if they don't want to renew their plans, here is an example:

2.2.2 How to create "Tiers" for members (Ghost 5.X)

For Ghost 5.x Price Tables are created automatically if you connect Stripe pay system, you can check the full guide here: https://ghost.org/help/setup-members/

Important note: Don't forget to create the required 4 pages detailed in step "2.2.1" from this documentation.

2.3. Basic theme usage

How to change the logo

Breek supports text and image logo. By default text logo is used, if you want a image logo you can do the next steps:

  • Go to Settings/General
  • Go to Blog Logo and click upload image.
  • Click Save.

Setting a post featured image (Ghost 3.x and lower)

We recommend to set a post image this will set the image just above the post title, like the next image:

To add the featured image for every post you must follow the next steps:

  • Click the cog icon (on left side of update/save button).
  • You will see a new sidebar has opened.
  • Click on Add post image and upload your thumbnail like the screenshot.
  • Click update/ save.

How to create an static page (Ghost 3.x and lower)

  • Go to New Post.
  • Set a title and content.
  • Go to post settings (cog icon next to save button).
  • Check Static Page and in the url field set about (like the next image).

Creating the navigation menu.

Note: This feature is available on ghost 0.5.9 and higher.

  • Login into your admin.
  • Go to "Settings" -> "Navigation".
  • You can create some links like: home, contact or gallery if you are actually using them.

How to create a gallery

Breek is compatible with the latest gallery feature from Koenig Editor.

First you must click "plus" button and select gallery:

After you select some images you will see a custom grid like this:

Finally click save and you will see you custom gallery on the post content, it is important to know every image can be clicked and displayed on a custom lightbox, so you must upload good quality images.

2.4. Plugins configuration

2.4.1 Main Theme Configurations

On Ghost 4.x and higher there is a new theme options panel, here it will located the most important options of the theme.

To access to these options you must:

  • Log In into your admin.
  • Click the "cog" icon on the left side.
  • Go to "Design"

  • Log In into your admin.
  • Click "Site wide" toggle.
  • You will see the custom options available for the theme.

2.4.2 How to Enable Native Comments

In case of using Native Comments, just go to Admin -> Settings -> Membership and enable commenting:

 

Main Config File (Ghost 3.0 and lower)

Inside breek/defaults.hbs file (line nº 37) you will find some important parameters that the theme will use, example:

var theme_config = {
masonry: 'on', // If you don't need masonry style, just set to "off"
sticky_sidebar: 'on', // on / off
disqus_shortname: 'ghostexample', // You can create your own Disqus Comments here: https://disqus.com/admin/create/
};

So, before you upload your theme is highly recommendable to edit these parameters with your own profiles.

How to get the Disqus Shortname

Disqus comments works like any JS api. You can create your Disqus code in the next url: http://disqus.com/admin/create/

If you don't have a Disqus account just create it (it's free) then open the url: http://disqus.com/admin/create/

Now you can see something like this:

Your unique "Disqus URL" is your shortname copy that name and click finish registration.

In this case will be disqus-example. Now we have our disqus shortname and we must change our template to view these changes..

  • Go to the directory where is your template.
  • Go to /content/themes/breek and open the next file: default.hbs and search for disqus_shortname = 'ghostexample;
  • Change with your shortname, in this case 'disqus-example';
  • Save the file and upload to your ghost installation.
  • Optional, you can verify if all is correct clicking Verify on disqus steps (where we get our shortname).

2.5. Reserved tags for the theme

Breek uses some important tags to extend ghost functionalities, these tags are:

  • bgstyle: it will display post image as a background in the homepage.
  • fullcover: article content will be displayed in fullwidth mode.

These tags must be always in lower case and it is highly recommended to never use them as primary tag.

Example of correct usage:

In this case we used fullcover tag "in lowercase" in the 2nd position.

IMPORTANT: For Ghost 4.0 it is recommended to use these tags as internal.

2.6 How to add custom colors to the tags (Ghost 3.0 and lower)

You must follow the next steps:

  • Go to admin/code injection.
  • You must create a <style> html tag and inside that you must add the correct class asigned to every tag button.

Example:

The custom tag composition is the next ".ctag-id{ background-color: #333; }"

<style>
.ctag-universe{ background-color: #c580e3; }
.ctag-astronomy{ background-color: #4579f0; }
.ctag-space-travel{ background-color: #01e18a; }
.ctag-solar-system{ background-color: #ED586C; }
</style>

To find your tag ID you must use Google Chrome inspector (right click on a tag button, then inspect):

After that you will see the inspector with the highlighter HTML element, the data-id attribute will contain the correct class name to replace the color your need. For this example, it will be "ctag-solay-system".

Change Tag color for Ghost 4.0 and higher

You can use the default featured from your Ghost panel:

3. Advanced Setup (code knowledge needed)

3.1. Add widgets to the template

Edit advertising section

Breek includes 1 strategic place to add advertising:

  • breek/partials/sidebar.hbs

It is important to replace the link "<a>" tag with your respective advertising or remove the div container if you are not going to use them.

How to add widgets to the sidebar

  • Go to breek/partials/sidebar.hbs
  • Edit any current widget or add a new copying the next lines of code:
<!-- start: .widget -->
<section class="widget widget-text">
<h4 class="widget-title title bordered">Text Widget</h4>
<div class="textwidget">
<p>Text widget content...</p>
</div>
<div class="clear"></div>
</section>
<!-- end: .widget -->

So if you want to add an iframe or any embed you must replace the paragraphs (<p>) with your iframe code.

3.2. How translate the theme

Breek supports multiples languages but you need to add your own lang file for this purpose:

  • Go to Settings/General -> Publication Language
  • Click "expand" and change to your correct lang code, for example: French is "fr", Spanish is "es".
  • Click Save.

After that, you need to add an extra files inside breek/locales/fr.json

We recommend to copy en.json file and start translating every text inside this file.

3.3. Syntax Highlighter

Breek supports code highlighting via Prism Plugin: you can check the plugin documentation here.

If you want to highlight your code, you must always use <pre class="language-X"><code></code></pre> tags, where X can be: html, css, js, php, etc.

Highlight HTML example:

Line numbers class is optional, so if you want to show short code examples, you can use <pre class="language-html"></pre>

Important: you must escape your code (only for HTML) before paste into your Ghost markup, for example https://www.freeformatter.com/html-escape.html

3.4. Enable search engine (API Key, Ghost 3.x and lower)

On Ghost v2.12 and later moved the old Beta API to the new Content API, this require some steps if you want to get it work the search engine.

  • Login into your Ghost admin.
  • Go to integrations.
  • Click on "add custom integration" button.
  • Add a name like "Search Engine".

  • Click create.
  • Copy the Content API Key.
  • Open breek/default.hbs file and edit line nº 35 search_engine_key = "";

Finally save your file, ZIP breek folder and upload into your Ghost admin.

4. CSS Styles

This project uses the following .css files for development:

  • assets/dist/grids-ie.css - Unsemantic grids for IE.
  • assets/scss/font-awesome.min.css - font awesome icons.
  • assets/scss/jquery.magnific-popup.scss - MagnificPopup jQuery Lightbox.
  • assets/scss/tooltipster.scss - Main tooltipter assets.
  • assets/scss/prism.scss - Syntax Highlighter styles.
  • assets/scss/*.scss - Main project styles, this folder includes: reset, grids, template style and responsive media queries.

In production mode we use the next minified CSS files:

  • assets/css/plugins.min.css - all external plugins in one large file used in the template.
  • assets/css/style.min.css- Main project styles minified and optimized.

5. How to change template main color

For Ghost 4.0 and higher you can easily change main color visiting Admin -> Settings -> branding (no coding required):

How to edit main color by code (SCSS)

Breek is working on SCSS, the major improvement about this, is the possibility to change main and secondary color easily.

If you want to change the main color you must follow the next steps:

1.- Unzip breek.zip (this is the template only file) and remember where is the folder location.

2.- Install a SASS compiler, we recommend you to use Prepos 6, you can download it here.

3.- After installed you must see a window like this (just click continue trial):

3.-Click on "Add Project" on the left bottom side.

4.- Search for breek folder (where you already unziped the project).

5.- Click on config icon -> refresh, this will load Prepos 6 Config file inside theme, so everytime you save a SCSS or JS file, it will be minified and saved into breek/assets/dist folder.

6.- Open breek/assets/scss/_settings.scss file and change the color that you want, example:

7.- After you save settings file, you will see a notification if there isn't any error:

8.- Zip Breek Folder and reupload into your Ghost Installation.

6. Javascript Files

Plugins and libraries

Development mode

Production

  • assets/dist/scripts.min.js - all external plugins and functions in one large file used in the template.

IMPORTANT: if you are a developer and you need to ADD JS changes, we recomment you to edit functions.js and use Prepos 6 to autocompile your code changes.

7. Optimization

This section will explain the basics concepts of optimization to get the highest score on Google Page Speed test.

7.1 Image Optimization

There is a lot of recommeded tools for this purpose, if you don't want to loss image quality, just skip this section.

Highest compression tool: Toolur

Website: http://compressimage.toolur.com/

We tested several compression tools and toolur online, is one of the best if you want to get 0 errors on Google Insight.

Recommended options:

  • Compression method: C
  • Image Quality: 70%
  • Don't resize and don't enlarge images.

TinyPNG: good quality and weight balance

TinyPNG is one of the most used compressor in the web, has a very basic interface and you will lost almost 10 - 15% quality. Its is highly recommended if you want to optimize your images without loosing quality.

Website: https://tinypng.com/

FileOptimizer: desktop APP

This application has the a good balance pretty closer like TinyPNG but as a desktop app.

Website: https://sourceforge.net/projects/nikkhokkho/files/FileOptimizer/

The only one important thing, is to enable "allow lossy optimizations":

7.2. Code editing CSS/JS

If you need to edit some CSS we recommend to add your changes at line nº 31 for example, in the next screenshot we changed the header background to a dark green::

If you want to minify your code, we recommend you to use CSS Minify: https://cssminifier.com/

JS Minify: https://javascript-minifier.com/

The steps are pretty similar to CSS, you just need to copy your code into assets/dist/scripts.min.js at line nº 100 and it is highly recommended to minify your code.

If you are familiarized with Javascript (developer) and you need to add extra jQuery functions, we recommend you to download Prepos 6 and load the prepos-6.config file into Prepos APP, this will help you to compile js/functions.js and minify all your code automatically.

8. Fonts used

9. Credits.

Fonts Icons

By Font Awesome

Images

Unsplash:

https://www.freepik.com/

10. Support

If you have any questions, please use our profile contact form on Envato http://themeforest.net/user/estudiopatagon

In case you find any bug, issue or just having some problems with the theme, use our ticket system: https://estudiopatagon.ticksy.com/