Rescue Jekyll Theme Documentation

Latest Version: 1.0.0

Introduction


Rescue Jekyll is a Jekyll pet animals theme, that provides you with pages required to setup a digital marketplace for pets.

Thank you for purchasing the theme. We provide support for all of our themes at https://support.thescube.com/, but please make sure you read this documentation in it’s entirety first. Thanks again!

Theme Installation


Installing The Theme

Plugins


Installed Plugins

Note: Required Plugins are Mandatory. The theme will not work properly, if its not installed & activated.

Configuration Options Setup


We can make the Configuration Setup in _config.yml file.

Basic Settings

title: Rescue An Animal Shelter jekyll Template
description: >-  # this means to ignore newlines until "baseurl:"
  An Animal Shelter jekyll Template

Logo And Favicon Settings

This section has options to setup Logo & Favicon.

# Logo & Favicon Settings
logo: /assets/images/Rescue-Logo-White.png  # Use logo icon here
logo-width: 150px  # Use logo width here (default 150px)
favicon: /assets/images/Rescue-Favicon.png  # Use favicon here

Font Settings

This section has options to setup Font for your site.

Add the style sheet for your font here.

# Font settings
font:
- font-style-url: https://fonts.googleapis.com/css?family=Merriweather&display=swap  # Use font url here.

Header Settings

This section has options to setup the header navigation menu for your site.

# Header Settings
header-layout: header-1  # Use options header-1, header-2
header-widget: false  # Use options true or false
header-social-icon: false  # Use Options true or false
telephone:  # Use telephone number (used in header-2 layout)
email: # Use email id (used in header-2 layout)
working-hours: # Use Working-hours (used in header-2 layout)
# Footer-columns
footer-title:  # Use footer title here
laptop: 3  # Use Options 1,2,3,4,6  Default: 3
tablet: 3  # Use Options 1,2,3,4 Default: 2
mobile: 1  # Use Options 1,2 Default: 1

Footer copyright credits can be used here

# Copyright Settings
copyright-content: true  # Use Options true or false
copyright-logo:  # Enter the copyright logo path
copyright-text: © 2020 Rescue - <a href="https://scube.co/themes/rescue-html" target="_blank" title="Rescue">Animal Shelter Pet Theme</a> <br />By <a href="https://scube.co/themes/" target="_blank" title="Scube theme">SCube Theme</a>.  # Enter the copyright content for your website

Post Settings

This section has settings for post options.

# Post Settings
# - Individual Post
post-layout: right-sidebar  # Use options left-sidebar, right-sidebar, full-width
post-meta: true  # Use options true or false
social-share: true  # Use options true or false

Pagination Settings

This section has basic setting for the pagination.

# Pagination Settings
pagination:
  enabled: true  # Use options true or false
  per_page: 6  # Use number of post per page
  permalink: '/page/:num/'  # Use pagination permalink here
  title: ' - page :num'  # Use pagination title  here
  limit: 0  # Use pagination limit here
  sort_field: 'date'  # Use  sort_field options here
  sort_reverse: true  # Use options true or false

Archive Settings

This section has basic setting for the Archive.

# Jekyll Archive Settings
jekyll-archives:
  enabled:
    - categories
    - tags
    - breed
  layout: do-category-archive
  permalinks:
    category: '/category/:name/'
    tag: '/tag/:name/'
    breed: '/breed/:name/'


How to Create Menu

- title: Home  # Use header title here
  href: /  # Use header title url here
- title: Our Pets  # Use header title here
  href: "#"  # Use header title url here
  option:
    - title: All Pets
      href: /pets-all/
    - title: Cats
      href: /pets-cats/
    - title: Dogs
      href: /pets-dogs/

This yml’s value will be used on {% include do-header-1.html %} and this do-header-1.html is included on the layout.

/assets/images/rescue/jek-doc-10.png

footer-copyright:
- copyright-links:
    - title: Home  # Use footer-copyright links name here
      href: /  # Use footer-copyright links url here
    - title: All Pets  # Use footer-copyright links name here
      href: /pets-all/ # Use footer-copyright links url here
    - title: Full Width Page  # Use footer-copyright links name here
      href: /page-full/  # Use footer-copyright links url here
footer:
- title: New Pets  # Use footer title here  # Use footer option icons here
  option:
    - title: Cinderella  # Use footer option links name here
      href: "/rescue/cindrella/"  # Use footer option url here
      icon:  # Use footer option icons here
    - title: Chester  # Use footer option links name here
      href: "/rescue/chester/"  # Use footer option url here
      icon:  # Use footer option icons here

Includes

Login

Description

Login is an include form which consist of a user name and password, which can be embeded anywhere in the page for authentication purpose.

/assets/images/rescue/jek-doc-15.png

How to add on page

Signup

Description

Signup is an form which can be embeded as a user register form on any page.

/assets/images/rescue/jek-doc-18.png

How to add in page

Forgot Password

Description

Forgot Password is an form used to get a code incase of forgetting password for an existing user, which can be embeded anywhere in the page as include.

/assets/images/rescue/jek-doc-13.png

How to add on page
Description

/assets/images/rescue/jek-doc-19.png

How to add content
# carousel version 1.0.0
carousel:
- title:  # Use carousel title name here
  image: /assets/images/animals/2_3c4dIFYFU.jpg  # Use carousel image here
  description:   # Use carousel description here
  button-text:  # Use button text here
  href:  # Use carousel href here
  tags: home  # Use carousel tag name here

- title:  # Use carousel title name here
  image: /assets/images/animals/3.jpg  # Use carousel image here
  description:   # Use carousel description here
  button-text:  # Use button text here
  href:  # Use carousel href here
  tags: home  # Use carousel tag name here

How to add in page

Form

Description

Form is an html block which provides the user to contact the owner of the site with its available elements. This form is just a example one which you can embed on your site.

/assets/images/rescue/jek-doc-14.png

How to add on page

Hero Content

Hero Content contains two columns one with image and other with text.

/assets/images/rescue/jek-doc-45.png

Available Options
How to add content
- title: Drive impact faster and with confidence  # Use hero-content title here
  description: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  # Use hero-content description here
  image: /assets/images/platform/platform_module3.png  # Use hero-content image path here
  button:
    - button-name: read more  # Use hero-content button name here
      button-href: "#" # Use hero-content url path here
      icon-button-name: Learn More  # Use hero-content icon-button name here
      icon-button-href: "#"  # Use hero-content icon-button-url path here
  tag: samples  # Use hero-content tag here
How to add in page

Pagination

Description

Pagination is the sequence of numbers assigned to pages in a book. Each page can have multiple articles.

Inorder to use pagination, Enable pagination in _config.yml. Click here for more information.

/assets/images/rescue/jek-doc-46.png

How to add on page

Page Title

Description
How to add content
page-title:
  - enabled: true
    custom-title: Contact
    description: Habitant morbi tristique senectus et netus. Semper viverra nam libero justo laoreet sit amet. Sit amet massa vitae tortor condimentum lacinia quis vel eros.
    button-text:
    button-link:
    background-color:
    background-image: /assets/images/contact-banner-1.jpg
How to add in page

Pets Archive

This section displays a list of pets archive for blog post on the site in a grid style.

Code:


{% include do-pets-archive.html %}

/assets/images/rescue/jek-doc-47.png

How to add content
pagination:
  enabled: true
  per_page: 6
  category: dogs
How to add in page

Post Archive Grid

This section displays a list of archive for blog post on the site in a grid style.

Code:


{% include do-post-archive-grid.html columns="3" %}

/assets/images/rescue/jek-doc-48.png

How to add content
pagination:
  enabled: true
  per_page: 6
  category:
  sort_field: 'date'  # Use  sort_field options here
  trail:
    before: 1 # The number of links before the current page
    after: 1  # The number of links after the current page
How to add in page

Post Archive Masonry

This section displays a list of archive for blog post on the site in a masonry style.

Code:


{% include do-post-archive-masonry.html%}

/assets/images/rescue/jek-doc-49.png

How to add content
How to add in page

Post Archive Thumbnail

This section displays a list of archive for blog post on the site in a thumbnail style.

Code:


{% include do-post-archive-thumbnail.html%}

/assets/images/rescue/jek-doc-50.png

How to add content

Side Widget

Description

This section displays a variety of information to the right or left side of web page.

Sidewidget options
# side-widget version 1.0.0
side-widget:
- recent-post:  # Use true or false
  categories: true # Use true or false
  widget-hours: true # Use true or false
  title:  # Use side-widget title here
  content:  # Use side-widget content here
  image:   # Use side-widget image here
  image-alt:   # Use side-widget image-alt here
  nav:  # Use side-widget nav name here
  megamenu:   # Use side-widget megamenu-type here
  newsletter: true  # Use true or false
How to add in page

Title

This section displays a title, description, a button with link and a bottom image section.

Code:


{% include do-title.html tag="thumbnail" %}

How to add content
How to add in page

Jekyll file directory


Note: To work with jekyll you should have a clear knowledge with jekyll directories and files.

Jekyll Directories

Jekyll Files

Troubleshoot