Author: ThemeStarz
Web: http://www.themestarz.net

CreaSoon Documentation

Thank you for purchasing our template! This is the documentation that will help you with customizing and orienting in the template.

Important! This is a static HTML template and not a WordPress theme! It doesn't have any admin/back-end panel and it is created for the developers or people who knows the HTML code. If this is not you have intended to buy, you can ask for a refund.

Getting started

Before you dive into code, you we want you to explain how the template is structured and organized, what support is included, what tools did we have used etc.

Help & Support

All the items you buy are quality checked by Envato. Any future update made available by the author is included with every purchase.

Item support includes:
  • Availability of the author to answer questions
  • Get assistance with reported bugs and issues
  • Help with included 3rd party assets
Item support does not include:
  • Customizations and installations

For more details, view the item support policy

Support is node via email at support@themestarz.net (recommended) or Our Dashboard.

How to find a version of your template

Go to assets/css and open style.css. Here you can find a Version at the very top.

Folder Structure

CreaSoon

Main (root) folder with index HTML files and assets folder

assets
bootstrap

Includes minified Bootstrap JS and CSS files.

css

Template style.css and other plugins CSS files.

font-awesome

Font Awesome (icons) CSS files and font files.

img

Images that are used in the template.

js

Template custom.js and other JS plugins.

pcss

Source for PostCSS (.pcss) files that we've used to create style.css

php

PHP files used in the template. For example email.php for email sending.

Layout

Template is build with mobile first approach. It is responsive and uses Bootstrap grid system. Base layout includes three sections.

  • Header
  • Main Content
  • Footer
  • Background
<html>
<head>
<!--CSS includes-->
</head>
<body>
<div class="page-wrapper">

    <header><!--navigation--></header>
    <div class="content-wrapper"><!--main content--></div>
    <footer><!--footer--></footer>

</div>

<div class="modal"><!--modals--></div>

<script>
//JS plugins includes
</script>
</body>
</html>

Basic Customization

How To Edit Files

You can use whatever text editor you like, even default Text Editor in the OS. But we recommend to use the one with th syntax highlighting such as:

How To Change Fonts

  1. If you are not satisfied with the default font, you can choose from hundreds ones from the Google Fonts. After you are happy with the selected font, click SEE SPECIMEN. You'll be redirected to to font detail. Then click Select this font. Popup window will show with text "1 Family Selected" - click it. Then you can customize your selection by clicking Customize. When you are done copy the text in standard tab.
    For example
  2. Then open the HTML file where you want to change fonts and find the ... element which loads the Google font in the <head> tag and place your copied code.
  3. Final step is to change the font family in the stle.css file. Open it and find body tag on the beginning of the file and font-family inside. Go back to Google Fonts page where you have chose your font and copy the line placed in the Specify in CSS. In this example it is font-family: 'Source Sans Pro', sans-serif;

How To Change Colors - Simple Way

There are two method how to change the main color. 1st Just by replacing the HEX color value in the style.css (simple) and 2nd by installing node.sj and PostCSS (advanced). Here is the simple way.

Let say, that you want to change the default red color to blue one:

  1. Open the style.css in assets/css/ folder
  2. Find the HEX value of the Default Color. If the default color is red, then HEX value is #ff0000
  3. In your text editor find Replace or Find and Replace function
  4. As original text enter the red color #ff0000 (template default color)
  5. As Replace with enter HEX value of blue color #0000ff

Font Awesome Icons

Font Awesome includes more than 900 icons that can be easily used on your site. For example you want the download link with the PDF icon.

  1. Go to Font Awesome Icons gallery and find the one you need. I our example it is file-pdf. Click the detail, then find and copy .
  2. Place the copied line to your link: Download File
  3. Final result: Download File

Advanced Customization

Compiling CSS with PostCSS

Template is built with PostCSS. A tool for transforming CSS with JavaScript. We have stopped using SASS or LESS, because they are big and slow. In order to use PostCSS, you need to be a little bit familiar with the command line.

Installing and Using PostCSS

This process will guide you how to easily install and use PostCSS with command line.

  1. Install node.js to your computer. Note, that Windows XP is not supported.
  2. After successful installation, open the Node.js command prompt from you installed applications. Alternatively you can just run a command line in your operating system.
  3. Now we need to install the PostCSS. In the opened command line enter npm install -g postcss -g postcss-cli. This will install PostCSS and PostCSS-CLI (command line interface)
  4. The next step is to install required PostCSS plugins. Again, into command line enter this: npm install -g autoprefixer -g postcss-mixins -g postcss-nesting -g postcss-import -g precss -g postcss-hexrgba -g postcss-conditionals -g postcss-for -g postcss-pixels-to-rem -g postcss-hocus -g postcss-sass-color-functions -g postcss-remove-root -g postcss-if-media -g css-mqpacker -g perfectionist . This will install all the plugins we have used.
  5. You can now test, if your PostCSS is running by entering postcss --help into command line
  6. Now you need to navigate into directory with your template. We'll use command line again. For example, your template is in this path: c:/websites/cryptonex. But PostCSS (.pcss) files are placed deeper in the assets/pcss folder. So the full path is c:/websites/cryptonex/assets/pcss. So enter the path to your template \path\to\assets\pcss. In our example enter this to command line: \websites\cryptonex\assets\pcss
  7. The final step is to compile the .pcss files into .css. Enter this into command line: postcss pcss/style.pcss -o css/style.css --watch --no-map

Thanks to --watch flag, the last command allows you to edit .pcss file without reentering the command. It will automatically determine that the file is changed and recompiles it.

PostCSS files structure

PostCSS .pcss files are located in assets/pcss folder. There are couple of another folders:

  • components components that are used in HTML code
  • helpers these files are utilities used in HTML and PostCSS files
  • plugins styling for plugins
  • template-specific styling for components that are unique for the template

JavaScript

JavaScript (JS) files/plugins are located in the assets/js folder and in the HTML file they are called using code. All JS files are located at the bottom of the HTML file. custom.js file is the template's JS file that includes scripts for running other plugins.

Note: You will need to modify only custom.js file. Read more about it in the Plugins section.

Email Form

CreaSoon comes with working email forms. You can use them for contact, subscribe or other forms that will collect the user's email address and send it to your receiving one.

Important! Every email form must have ts-form-email class

Note: It is better to test email sending on live server or on localhost with the library such as PHPMailer as it does not work on a local machine.

Setup a path to PHP file

In your <form> element you need to specify a path to the .php file that will handle the email sending using data-php-path attribute.
As a default it is assets/php/email.php.

<form class="ts-form ts-form-email" data-php-path="assets/php/email.php">
<div class="form-group">
<label for="name">Your Name</label>
<input type="text" class="form-control" id="name" name="name" required>
</div>
<div class="form-group">
<button type="submit" class="btn btn-primary">Send a Message</button>
</div>
</form>

Note: You can use different .php file for each form. For example one for contact form and another for subscribe form.

Setup a Receiving Email Address

You have to setup your own email address for email receiving. As a default it is hello@example.com and it is located in the assets/php/email.php.
How to change the address:

Go to assets/php/email.php and find $to = 'hello@example.com'; and change the address to your own.

Plugins

Here is the list of the JS plugins used in the template. Usually they are loaded from assets/js folder.

Important! Every JS plugin loaded from assets/js must be called BEFORE the custom.js
<script src="assets/js/jquery-3.3.1.min.js"></script>

<!-- Plugins from assets/js -->

<script src="assets/js/custom.js"></script>

<!-- Other inline plugins such as Google Maps -->

Google Maps

Plugin Documentation

Create a Map Element

To use a Google Maps on your site, you need to create a map element with map class and give it a unique ID first:

<div id="map-element" class="map"></div>

Get a Google Maps API Key

You have to obtain your unique API key for the Google Map, otherwise you can see this error:

Oops Something Went Wrong Error

To get an API key:

Configuring the Map

You can set center of the map, marker and map style. In the very bottom of the HTML file with the map element you can find:

<script>
var latitude = 34.038405;
var longitude = -117.946944;
var markerImage = "assets/img/map-marker-w.png";
var mapElement = "map-element";
var mapStyle = [{"featureType":"all","elementType":"labels.text.fill","stylers":[{"color":"#ffffff"}]},{"featureType":"all","elementType":"labels.text.stroke","stylers":[{"visibility":"on"},{"color":"#424b5b"},{"weight":2},{"gamma":"1"}]},{"featureType":"all","elementType":"labels.icon","stylers":[{"visibility":"off"}]},{"featureType":"administrative","elementType":"geometry","stylers":[{"weight":0.6},{"color":"#545b6b"},{"gamma":"0"}]},{"featureType":"landscape","elementType":"geometry","stylers":[{"color":"#545b6b"},{"gamma":"1"},{"weight":"10"}]},{"featureType":"poi","elementType":"geometry","stylers":[{"color":"#666c7b"}]},{"featureType":"poi.park","elementType":"geometry","stylers":[{"color":"#545b6b"}]},{"featureType":"road","elementType":"geometry","stylers":[{"color":"#424a5b"},{"lightness":"0"}]},{"featureType":"transit","elementType":"geometry","stylers":[{"color":"#666c7b"}]},{"featureType":"water","elementType":"geometry","stylers":[{"color":"#2e3546"}]}];
google.maps.event.addDomListener(window, 'load', simpleMap(latitude, longitude, markerImage, mapStyle, mapElement));
</script>
  • var latitude latitude of the map center
  • var longitude longitude of the map center
  • var markerImage path to marker image. You can choose between map-marker.png (black marker) and the map-marker-w.png (white marker).
  • mapElement ID of the map element
  • mapStyle color theme of the map. You can find more on Snazzy Maps

Count Down

Plugin Documentation

Simple plugin that shows remaining time of the event.

Necessary code for count down plugin:

  • <div class="ts-count-down"></div> element
  • data-date attribute with the final date
  • <script src="assets/js/jquery.countdown.min.js"></script>

Example: Final day is June 7 2019 at 15:03:26

<div class="ts-count-down" data-date="June 7, 2019 15:03:26"></div>