Development Guide

Documentation - v1.0

Vorix - Creative Digital Agency HTML Template

The vorix is a Static HTML5 Template:
We do not provide any documentation or email support on how to integrate with any CMS (such as WordPress, Joomla, etc.) or frameworks (such as Angular, Vue, React, Laravel etc.).

Get Help

Thank you for purchased our item(s). If you have any questions that are beyond the scope of this help file, please feel free to email via support page here. Thank you so much!

In some cases, you may have to wait 2 working days to get an email answer. However, we will try to answer you as soon as possible. Replies are sometimes delayed due to multiple emails and time zone variations.

Files Structure

  • vorix
    • dist (compiled distribution files)
    • node_modules (npm dependencies files. It is NOT included in the downloaded file, this folder will be installed automatically when you install npm).
    • src (all source files)
      • html (all .html files into this folder)
      • scss (all .scss files into this folder)
    • static (all static assets)
      • img (all images)
      • js (all static .js files)
    • .browerslistrc
    • changelog.txt
    • gulpfile.js
    • license
    • package.json
    • package-lock.json (this file NOT included in the downloaded file, this file will be automatically created when you run gulp)

Code Editor

There are many code editors for web code editing. You can use whatever you want. We recommend that you use Visual Studio Code . Because - this template is coded using it.

Installation

It has a directory (vorix/dist) of compiled files. If you want to edit without source files (plain HTML/CSS/JS files), you do not need to install anything on your machine.

You need to install package files/dependencies for this project if you want to customize it. To do this, you must have node and npm installed on your computer. Installation guide of the node can be found here.

As npm comes bundled with a node, a separate installation of npm is NOT needed. If you have installed them, just go to the root folder and run the following command in your command prompt or terminal.

npm install

Run Gulp

Run a command to run Gulp. When you run this command, it also watching at all source and static files. So, you don't need to run another command to watching these.

npm run dev

If you want, just watch the source files. You can run another individual command.

npm run dev watch

Know the file type

Source files:

Source files are files that are processed with template build tools to make the browser readable. E.g. SCSS & row HTML files always source files.

Files location: vorix > "src" folder

Compiled files:

Compiled files are files generated as a result of running a compilation process in the source files. E.g. CSS & standard HTML files always compiled files.

Files location: vorix > "dist" folder

Static files:

Static files are ones that aren’t processed or generated. E.g. Images, Web Icon Fonts and standard HTML are static files.

Files location: vorix > "static" folder

SCSS files

Sass stands for Syntactically Awesome Stylesheet. Sass is the most mature, stable, and powerful professional grade CSS extension language in the world. It's gives you variables, nesting, partials, modules, mixins, extend/inheritance & operators, etc.

Visit the official website to learn the details.
SCSS Files Layout
File Description
style.scss Core stylesheet
_about.scss About Section CSS
_awards.scss Awards Section CSS
_blog.scss Blog Section CSS
_breadcrumb.scss Breadcrumb Section CSS
_color.scss Color Section CSS
_contact.scss Contact Section CSS
_cta.scss Call To Action Section CSS
_cookie.scss Cookie Section CSS
_demo.scss Preview Section CSS
_faq.scss FAQ Section CSS
_feature.scss Feature Section CSS
_feedback.scss Feedback Section CSS
_footer.scss Footer Section CSS
_header.scss Header Section CSS
_hero.scss Hero Section CSS
_jarallax.scss Jarallax CSS
_light.scss Light Mode CSS
_mi.scss Material Fonts
_partner.scss Partner Section CSS
_portfolio.scss Portfolio Section CSS
_preloader.scss Preloader Section CSS
_pricing.scss Pricing Section CSS
_process.scss Process Section CSS
_reboot.scss Reboot CSS
_register.scss Register Section CSS
_rs.scss Responsive CSS
_service.scss Service Section CSS
_shortcodes.scss Shortcode CSS
_team.scss Team Section CSS
_video.scss Video Section CSS

How to edit the Title & Favicon?

Open the mail file (vorix) in your code editor. Then open home-1.html file & customize as your desire.

File location: vorix > src > html > pages > home-1.html

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: vorix > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the Brand Logo?

Open the mail file (vorix) in your code editor. Then open home-1.html file & customize as your desire.

File location: vorix > src > html > pages > home-1.html

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: vorix > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the Footer Nav?

Open the mail file (vorix) in your code editor. Then open home-1.html file & customize as your desire.

File location: vorix > src > html > pages > home-1.html

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: vorix > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the template Colors?

Open the mail file (vorix) in your code editor. Then open _colors.scss file & customize as your desire.

File location: vorix > src > scss > _colors.scss

Customize with Complied Files

Open style.css file & customize as your desire.

File location: vorix > dist > style.css

Light Mode

If you want, you can use it as toggle switch mode or by default. Or, you can delete this.

If you want to use it in default mode, use the following code in the <body> tag.

.light-mode

If not, delete the code and toggle switch code from the template.

vorix > src > scss > _light.scss

Customize with Complied Files

Working with compiled files is very easy. You don't need any build tools or local setup to edit the template. A folder (vorix/dist) is already provided with the template. Open this folder and edit it as your desired.

Recompiling will overwrite your all changes!

When you will customize with compile files, please do not run the template build tools. If you run the template build tools again, all your changes will be overwritten.

Third Party Plugins Activation

Name Plugins Activation Code
Swiper Slider
const serviceSwiper = document.querySelector('.service-swiper')

if (serviceSwiper) {
    new Swiper('.service-swiper', {
        loop: true,
        slidesPerView: 4,
        spaceBetween: 30,
        autoplay: {
            delay: 4000,
            disableOnInteraction: false,
        },
        navigation: {
            nextEl: '.service-button-next',
            prevEl: '.service-button-prev',
        },
        breakpoints: {
            320: {
                slidesPerView: 1,
                spaceBetween: 10,
            },
            480: {
                slidesPerView: 1,
                spaceBetween: 20,
            },
            576: {
                slidesPerView: 2,
                spaceBetween: 20,
            },
            768: {
                slidesPerView: 3,
                spaceBetween: 20,
            },
            1200: {
                slidesPerView: 4,
                spaceBetween: 30,
            },
        },
    });
}
Marquee Slider
const catagorySlide = document.getElementById('catagorySlide');

if (catagorySlide) {
    Marquee3k.init();
}
Counter Up
let counterlen = document.querySelectorAll(".counter").length;

if (counterlen > 0) {
    let counterUp = window.counterUp.default;

    let callback = entries => {
        entries.forEach(entry => {
            let counterElement = entry.target
            if (entry.isIntersecting && !counterElement.classList.contains('is-visible')) {
                counterUp(counterElement, {
                    duration: 2000,
                    delay: 20
                });
                counterElement.classList.add('is-visible');
            }
        });
    }

    let IO = new IntersectionObserver(callback, {
        threshold: 1
    });

    let counterUpClass = document.querySelectorAll('.counter');
    let counterUpClasslen = counterUpClass.length;

    for (let i = 0; i < counterUpClasslen; i++) {
        IO.observe(counterUpClass[i]);
    }
}

Changelog(s)

Version 1.0.0
  • Initial Realease