Documentation | Lucha

## Installation

Follow the steps below to get started with your Site Template:

1. Unzip the downloaded zip file `themeforest-xxxxx.zip` folder
2. Open folder named `main-file`
3. Here you will find `assets` folders of all files. also there are other pages css and images folder. like: `about`,`blog-layout`,`chef-layout`, etc.
4. You will need to Upload these files to your Web Server using FTP in order to use it on your Website.
5. Make sure you upload the required files/folders listed below:
   - Followings are files and sub-folders saved in this folder
   - `css` - Extra Stylesheets Folder plus Main Stylesheet File
   - `images` - Images Folder
   - `js` - Javacripts Folder
   - `.html` extension files - main page template File
6. You will need to Upload these files to your Web Server using FTP in order to use it on your Website and give the paths of files in `.html` extension files.
7. You're now good to go..! Start adding your Content and show off your Brand New Beautiful Website in style.

## HTML Structure

Lucha follows a simple coding structure. here is the sample:

    <!DOCTYPE html>
    <html lang="zxx" dir="ltr>
    <head>
      <!-- All your metas will be here -->
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">

      <!-- Your Stylesheets, Title -->
    	...

    </head>

    <body>

      <!-- The Preloader Before Site Load -->
      <div class="preloader">
        ....
      </div>

      <!-- Start Header -->
      <header class="header">
          ...
      </header>
      <!-- End Header -->
      <!-- Page Wrapper -->
      <div id="wrap">
          ...
      </div>
      <!-- End Wrapper -->

      <!-- Footer Section -->
      <footer class="footer">
        ...
      </footer>

      <!-- All Modal here -->

      <!-- Scroll Bottom to Top Button -->
      <span class="scroll-top" data-scroll="up">
        ...
      </span>

    <!-- Your All Scripts will be here ->
    	...

    </body>
    </html>

### Favicons

You can add a Favicon to your Website using the following code just bottom to the Stylesheet files links:

    <assets/images/logo/favicon.ico" rel="icon" sizes="32x32">

## Changing Fonts

Change your Fonts from Google Fonts Library directly if you plan to use a Google Font. You can find the Linking to the Font Files in the `head` tag

    <link href="https://fonts.googleapis.com/css2?family=Courgette&family=Jost:wght@400;500,600&display=swap" rel="stylesheet">

In order to change the Fonts, you will need to Edit the Above Links with your Custom Font, if you plan to use a Google Font or Remove it completely if you plan to use a Self Hosted font. Here is an Example for using Self Hosted Fonts.

By default, Lucha uses one Font namely: `Courgette & Jost` from the Google Fonts Library

## Website Optimization Tips

A Fast & Optimized Website has several factors which needs to be implemented in order to achieve the desired results. There are several Optimization Techniques available which will definitely affect your Website's Performance in a Positive Way & we want to share a few of them with you:

- #### Image Compression & Optimization

  We tend to use Lots of Images on our Websites but we often do not make efforts to Compress & Optimize them. Remember, the Larger the Image, the more time it takes to download and therefore this slows your website loading times affecting User Experience. Your customer will leave your website if it does not load within 3-5 Seconds which adversely affects your Sales. Therefore, it is important to Resize, Optimize & Compress your Images before using it on your Website. Here are some Tips which might come handy in optimizing images:

  - Resize your Images: Resize your Images before using it on your Website. Do not just Download an Image & place it as it is in your Website's `<img>` Tag without resizing it. The size/resolution of the Image matters since it is not recommended to use an Image size of `1200px` x `800px` in a Content Size of `300px` x `200px` as this is unnecessary. Resize it to `300px` x `200px`
  - Image Formats: There are three common file types that are used for web images which are JPEG, GIF, & PNG. For images with a Flat Background use JPEG images, for images with a Transparent background use PNG images and for images with Animations use GIF images.
  - Compressing Images: Images Compression is important as it considerably reduces the size without losing the quality. There are several FREE Image Optimization Tools available to Download.
    For MAC use ImageOptim
    For Windows use Riot for compressing JPEG Images & PNG Gauntlet for PNG Images.

- #### CSS & jQuery Minifications

  It is also recommended that you Combine & Minify all your CSS Files to a single CSS File & all Javascript Files to a single JS File since Minification reduces the size of the File and Combining the files helps in reducing the number of HTTP requests made to the server. This is also an Important Factor in increasing the speed of your website. There are several tools available online to Minify your CSS & JS Files. Our recommendations are:
  For CSS use CSS Minifier and For Javascript use Javascript Minifier.

- #### Fast Web Hosting Servers

  A lot depends on your Web Hosting Servers, so it is recommended that you choose a Hosting Company/Server that provides a Reliable & a Fast Hosting Service. You can check out some recommended Hosting Services here: http://themeforest.net/get_hosting.

## Header

You can choose the headers while creating your Pages. Simply follow the structure below to create the header:

    <!-- Home Page1 Header -->
      <header class="header">
        <div class="main-header">
        ...
        </div>
      </header>

    <!-- Home Page2 Header-->
      <header class="header">
        <div class="header-top">
        ...
        </div>
        <div class="header-bottom">
        ...
        </div>
      </header>

## Mobile Header

You can get the Mobile header into `header-bottom` div. Simply follow the structure below to create the header:

      <!-- mobile header -->
          <div class="mobile-menu-wrap d-xl-none d-block">
            ...
          </div>

## Page Titles

Default Page Title style with Text aligned Center with background. Simply follow the structure below to create the Page Title:

    <section class="hero-slider">
      <div class="pagetitle-bg">
        <div class="big-banner" style="background-image: url(about/images/banner-4.jpg);"></div>
      </div>
      <div class="hero-overlay"></div>
      <div class="container page-title">
        <div class="hero text-center" data-aos="fade-up" data-aos-easing="linear" data-aos-duration="800">
          <h1 class="hero-title my-0">About Us</h1>
          <p class="mb-0 page-desc">We bring to you the unforgetable moment with our delicious dishes</p>
        </div>
      </div>
    </section>

## Columns & Grid

### Bootstrap Grid

.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-1
.col-md-2
.col-md-2
.col-md-2
.col-md-2
.col-md-2
.col-md-2
.col-md-3
.col-md-3
.col-md-3
.col-md-3
.col-md-4
.col-md-4
.col-md-4
.col-md-5
.col-md-5
.col-md-2
.col-md-6
.col-md-6
.col-md-1
.col-md-11
.col-md-2
.col-md-10
.col-md-3
.col-md-9
.col-md-4
.col-md-8
.col-md-5
.col-md-7

## Slider Types & their Options

Lucha includes Sliders are mentioned as follows:

- Swiper Slider

  You can find the Swiper Slider related Documentation here.

  Swiper Slider
- You can find all the scripts for all the sldiers into `style.js` file. like this:
  1. Hero Slider
  2. Gallery Slider
  3. Chef Slider
  4. Blog Slider
  5. Testimonial Slider
  6. Product Gallery Slider
  7. Related Blog Slider
  8. Sidebar Gallery Slider

## Introduction

Lucha boasts of a many handy Shortcodes which are quite powerful, flexible, functional & easy to use. Setting up shortcodes is very easy & Self Explanatory. Here is the List of Shortcodes included :

- `Default css`
- `Button`
- `Animations`
- `All heading`
- `Header`
- `Hero slider`
- `About Us`
- `Coutner`
- `Menu Section`
- `Reservation`
- `Service`
- `Gallery`
- `Chef slider`
- `Blog`
- `Subscribe-Form`
- `Testimonials`
- `Footer`
- `scroll to top button`
- `Inner Page Title`
- `Pagination`
- `Comment Section`
- `Contact US page`
- `404 page`
- `Preloader`

Each of the above mentioned Shortcodes are easily extendable, flexible & easy to use. You can find the sample codes in their respective files. We are explaining a few of them for your Reference.

## Animations

Scroll to reveal Animations are latest in the Trends. You can do them too with Bistro. You can use animations on any element you want. Here is the Sample Code:

    <div data-aos="fade-up" data-aos-easing="linear" data-aos-duration="800" ></div>

You can also use delays for your Animations:

For the more use of AOS Animation read documentation AOS - Animate.

## Icons

Remixicon

## Images

- The Stocks
- Unsplash
- Freepik
- RaumRot
- Picjumbo
- Stockphotos.io
- Imcreator FREE
- Flickr CC-Search
- Mazwai (Stock Footage)

## jQuery

- Swiper Slider
- Bootstrap 5
- AOS Animtion

## CSS & Fonts

- `style.css`- use Global css
- `responsive.css`- responsive media query css
- Bootstrap 5
- Animation
- Remixicon
- Swiper Slider
- Google Fonts - use Courgette & Jost