Howdy!
First of all, Thank you so much for purchasing this template and for being my loyal customer. You are entitled to get free updates to this product + exceptional support (as per market policy) from me directly.
This documentation is to help you undesrstand the template's structure. Please go through the documentation carefully to understand how this template is made and how to edit this properly. Basic HTML and CSS knowledge is required to customize this template. No worries, If you don't understand HTML and CSS. I can help you with simple edits :)
1. Getting Started
When you are ready to use this template, it is advised to upload the downloaded files to a local or remote server. In this regard, unzip the package you have downloaded from themeforest. In the extracted folder, you can see the following folders:
Package contents
- template — Contains all the original template files comprises of HTML, CSS, JS etc. This is the folder which you'll upload on your server after necessary modifications.
- documentation — Inside this folder you will find this same documentation updated with the latest changes.
3. Stylesheet Files
All styling realted files of this template can be found in the folder named css.
css/
|
|-- combined/
| -- page-essentials.min.css
| -- sven-essentials.min.css
|-- custom/
|-- fonts/
|-- vendor/
| -- bootstrap.min.css
| -- font-awesome.min.css
| -- bigvideo.css
| -- jquery.mCustomScrollbar.min.css
| -- photoswipe.min.css
| -- default-skin.min.css
|-- sven-teaser.css
|-- main.css
vendor folder consists of styles of few third party plugins and libraries used in the production of this template (list of which can be found at the end of this documentation). fonts folder consist of custom fonts. combined folder consists of multiple stylesheets minified / compressed into a few css files for page optimization.
sven-teaser.css file contains styles associated with Sven Teaser Plugin. main.css is the primary file which comprises of all basic styles for this template.custom folder consists of custom styles associated with each demo variant.
4. Javascript Files
All client-side related javascript files can be found in the js folder.
js/
|
|-- combined/
| -- page-essentials.min.js
| -- sven-essentials.min.js
| -- sven-motion.min.js
| -- html5-video.min.js
| -- sven-animations.min.js
| -- sven-transitions.min.js
|-- backgrounds/
|-- vendor/
| -- jquery.min.js
| -- bootstrap.min.js
| -- preloadjs-NEXT.min.js
| -- soundjs-NEXT.min.js
| -- video.js
| -- bigvideo.js
| -- jquery.mb.YTPlayer.min.js
| -- sven-dependencies.js
| and a lot more
|-- sven-teaser.min.js
|-- custom-animations.js
|-- index-main.js
combined folder consists of multiple js files minified and combined into a few JS files for page optimization.
backgrounds folder consists of canvas Animated Backgrounds written in JS.
vendor folder consists of third-party javascript libraries used in the template (list of which can be found at the end of this documentation).
sven-teaser.min.js - the sven Teaser plugin.
sven-animations.min.js - Basic Animations associated with Sven Teaser Plugin.
sven-transitions.min.js - Basic Transitions associated with Sven Teaser Plugin.
custom-animations.js - Animations associated with FIDES Intro
5. Files & Resources
The template uses following resources by third parties.
- jQuery
- Bootstrap
- [SoundJS, PreloadJS]
- BigVideo
- VideoJS
- jquery.mb.YTPlayer
- TweenMax
- Sven Teaser Plugin
- Big Text
- isMobile.js
- Google Fonts(Poppins,Roboto,etc.,)
- Font Awesome
- ifvisible.js
- PhotoSwipe
- jquery.countdown.min.js
- malihu jquery custom scrollbar plugin
- lazysizes
- object-fit-images
- Web Font Loader
- Particles JS
- Flat Surface Shader
- Milligram CSS Framework
Music Credits : Country Cue 1 by Audionautix is licensed under a Creative Commons Attribution license(https://creativecommons.org/licenses/by/4.0/)
Artist: http://audionautix.com/
6. Simple Customizations(FAQs)
Here is the list of few simple customizations which are frequently asked in support forum. Advanced customizations can be found here.
Choose the demo variant you wish to use for your website. Let's take index-main.html in our case. scene-1 uses rotator animation named fx9-mod1 which rotates the text separated by Choose the demo variant(html file). Add (or) Replace data-enable-sound attribute with your own sound url in the teaser element like the following.
preloadScenes - If set to true, all the scenes in the teaser are preloaded before started playing. In Internet explorer & mobile browsers, it takes more than a few seconds to preload all scenes as it involves heavy JS processing. By default, preloadScenes is set to false. Locate index-main.js file in the js folder and find the following property(go to line 189) and change the value to true.
You could add image to any of the scenes in the teaser. Choose the demo variant(html file). Add (or) Replace data-scene-image="images/backgrounds/slide-5.jpg" attribute with your own image url to any of the scenes like the following. Know more about the data-scene-dur, data-freeze-time by clicking here
You could add custom (or) google font to your teaser. 9.6.1 SET CUSTOM FONT Step 1: Locate the custom css file (index-main.css in our case) associated with the selected demo variant(index-main.html, index-main-logo.html) and find the following lines and Replace the font files and other declarations with your custom font Step 2: Locate the index-main.js file and find the following lines and replace the font-family with your custom font family 9.6.2 ADD GOOGLE FONT Step 1: Locate the custom css file (index-main.css in our case) associated with the selected demo variant(index-main.html, index-main-logo.html) and find the following lines and Replace the font name with your google font. Replace "Montserrat" with the google font you wish to use. Step 2: Locate the index-main.js file and load your google font like the following.Add / Remove text to rotator
. You can add / remove text as per your wish.
Add / Change music on the teaser
IMPORTANT!!! Please make sure to include / upload the ogg format of the audio to the same folder as the mp3 file (for supporting Android Native Browser) with the same file name.
Preload All Scenes
If set to false, only the first scene is preloaded and the teaser starts playing. Other scenes will be processed in a queue by a delay.
preloadScenes: false,
Add / Replace Image to any of the scenes
Set / Change font for the teaser
/* ==================================================================
1.0 Custom Font Declarations(if any)
================================================================== */
@font-face {
font-family:'TeXGyreHeros';
src: url('../fonts/TeXGyreHeros-Bold.eot');
src: url('../fonts/TeXGyreHeros-Bold.eot?#iefix') format('embedded-opentype'),
url('../fonts/TeXGyreHeros-Bold.woff2') format('woff2'),
url('../fonts/TeXGyreHeros-Bold.woff') format('woff'),
url('../fonts/TeXGyreHeros-Bold.svg#TeXGyreHeros-Bold') format('svg');
font-weight: 700;
font-style: normal;
font-stretch: normal;
unicode-range: U+0-10FFFF;
}
/* 2.1 Font Style Declarations and Other Fixes
-------------------------------------------------------------- */
.fontLoaded .sven-container, .splash-page, .pl-wrapper { /* Teaser Font */
font-family: 'TeXGyreHeros', sans-serif;
}
/* ==================================================================
1.0 Load Custom, Google Fonts
================================================================== */
WebFont.load({
custom: {
families: [ 'TeXGyreHeros' ]
},
classes: false,
timeout: 5000,
active: function() {
document.documentElement.className += " fontLoaded";
isFontActive = true;
$(document).trigger("fontActive");
},
fontinactive: function(familyName, fvd) {
isFontActive = true;
$(document).trigger("fontActive");
}
});
/* 2.1 Font Style Declarations and Other Fixes
-------------------------------------------------------------- */
.fontLoaded .sven-container, .splash-page, .pl-wrapper { /* Teaser Font */
font-family: 'Montserrat', sans-serif;
}
/* Could be replaced with the "Ralway" google font like below*/
/* 2.1 Font Style Declarations and Other Fixes
-------------------------------------------------------------- */
.fontLoaded .sven-container, .splash-page, .pl-wrapper { /* Teaser Font */
font-family: 'Raleway', sans-serif;
}
/* ==================================================================
1.0 Load Custom, Google Fonts
================================================================== */
WebFont.load({
google: {
families: ['Raleway:400,700']
},
classes: false,
timeout: 5000,
active: function() {
document.documentElement.className += " fontLoaded";
isFontActive = true;
$(document).trigger("fontActive");
},
fontinactive: function(familyName, fvd) {
isFontActive = true;
$(document).trigger("fontActive");
}
});
7. Page Speed Insights
1) Please use CDNs for third party libraries wherever possible instead of serving it from your own server. It helps loading the page faster.
2) Better use guetzli for compressing JPEG images.
For more info about page speed optimization, go here
https://developers.google.com/speed/pagespeed/insights/