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://www.scube.co/support/, but please make sure you read this documentation in it's entirety first. Thanks again!

Installing The Theme

• Copy the theme files to your website directory.
• To run the theme locally, navigate to the theme directory in your terminal
• Run bundle install to install the theme's dependencies.
• Then run jekyll serve to start the Jekyll server.
• If any error occurs click here to troubleshoot.

Installed Plugins

• Jekyll Feed plugin: We used Jekyll Feed plugin to generate an Atom (RSS-like) feed of your Jekyll posts. Click here to see the plugin.
• Jekyll SEO Tag: We used Jekyll Feed plugin to add metadata tags for search engines and social networks to better index and display your site's content. Click here to see the plugin.
• Jekyll Paginate V2: This plugin is used for pagination. It is responsible for reading the posts and collections in your site and split them correctly across multiple pages. Click here to see the plugin.
• Jekyll Archives: We used this plugin to generate post archives by tags and categories. Click here to see the plugin.

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

Basic Settings

• title: You can add your website title here.
• description: You can add a description about your website here.

Logo & Favicon Settings

This section has options to setup Logo & Favicon.

• logo: Add your logo to displays in the header section.
• logo-width: Add the width for the logo.
• favicon: Upload a favicon for the website.

Font Settings

This section has options to setup Font for your site.

Add the style sheet for your font here.

• font-style-url: Add your font css here.

Header Settings

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

• header-layout: Use options header-1, header-2. Use header-1 here so the header version one is used for navigation menu. Use header-2 here so the header-2 is used for navigation menu. Without using this option navigation menu will not be displayed.
• header-widget: Use options true or false. This widget option is used in header-2. Set this to true so that header-2 will have widgets.
• header-social-icon: Use options true or false. This widget option is used in header-2. Set this to true so that the social icons will be displayed on the header-2.
• telephone: Use telephone number for the site here. This widget option is used in header-2. This number will be used in telephone widget icon in header-2.
• email: Use email id for the site here. This widget option is used in header-2. This email id will be used in email widget icon in header-2.
• working-hours: Use working hours for the site here. This widget option is used in header-2. This will be displayed on header-2.

Footer Columns Settings

• footer-title: Use the title for the footer here.
• laptop: Number of columns for laptop devices can be used here.
• tablet: Number of columns for tablet devices can be used here.
• mobile: Number of columns for mobile devices can be used here.

Footer Copyright Settings

• Footer copyright credits can be used here

• Copyright-content: It has two options (true or false). Set it to true to use copyright content. Set it to false copyright section will not be displayed.
• Copyright-logo: Site logo can be placed here so that it will be displayed on the copyright section.
• Copyright-text: Copyright text can be used here.

Post Settings

This section has settings for post options.

• post-layout: Use options left-sidebar, right-sidebar, full-width. This option can be overridden by using the post layout in post front matter.
• post-meta: Use options true or false.
• social-share: Use options true or false. This option is for social share options on the sidewidget section.

Pagination Settings

This section has basic setting for the pagination.

• enabled: Site-wide kill switch, disabled here it doesn't run at all.
• per_page: How many objects per paginated page.
• permalink: The permalink structure for the paginated pages.
• title: Optional the title format for the paginated pages.
• limit: How many paginated pages to create.
• sort_field: Optional, defines the field that the posts should be sorted on.
• sort_reverse: Optional, sorts the posts in reverse order.

Archive Settings

This section has basic setting for the Archive.

• enabled: This option sets which types of archives will be created.
• layout: Sets the default layout to use.
• permalinks: Maps archive types to the permalink format used for archive pages.

• Rescue Header is created as an include, which is included in _layout > default.
• Use proper header version on config.yml file in header settings field.
• By default the theme use header-1.
• For header settings documentation click here.
• Rescue Header consists of 3 items: Logo/Site Title, Menu & Search form.

• Logo/Site Title: You can add logo and it's width in _config.yml > Logo & Favicon Settings tab. Click here for more information.
• Menu: To add in header menu, _data > do-menu.yml. Click here for more information.
• Search form: On clicking the search icon a searchform will be displayed which can be used for seaching throughout the site.

How to Create Menu

• To create Menu, On jekyll go to _data > and right click on it and click'create a new file' option.
• Enter the Menu name.
• Create an array under title menu and add the title, href and dropdowns.

Menu YML File

To add data on menu.

• title: title denotes menu's name.
• href: href denotes links for title.
• options: Array of option defines the dropdown.
• title: title denotes dropdown's menu name.
• href: href denotes links for dropdown's title.

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

• Rescue Footer is created as an include, which is included in _layout > default.
• Include variable for footer is {% include do-footer.html %}
• Rescue Footer consists of 2 items: Footer Widgets and Copyright & Credit.

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.

How to add on page

• It can be used by
{% include do-forgot-password.html %}

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.

How to add on page

• It can be used by
{% include do-form.html %}

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.

How to add in page

• It can be used by
{% include do-login.html %}

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.

How to add in page

• It should be added on page's front matter.

• enabled: page kill switch, disabled here it doesn't run this page. Enabled to use pagination.
• per_page: how many objects per paginated page.
• category: Pagination will obatain post based on the provided category.

Side Widget

Description

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

Sidewidget options

• Options are available in _data > do-side-widget.yml

• recent-post:Use true or false.
• categories:Use true or false.
• widget-hours: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:Use true or false

How to add in page

• It can be used by
{% include do-side-widget.html %}
• It has been used on page for various layouts on this theme.

Signup

Description

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

How to add in page

• It can be used by
{% include do-signup.html %}

Carousel

Description

Carousel is a block which continues slides number of content used in it. In this site we have used carousel to slide pet images infinitely.

How to add content

• Carousel content can be added in _data > do-carousel.yml


image: Add image url for the carousel here.

How to add in page

• It can be used by
{% include do-carousel.html id="one" tag="home" %}
• id: Use a unique id for the carousel.
• tag: Use the tag for the carosel as include variable.

• A jekyll site consist of these following directories and files.
• Jekyll directories
• _data
• _includes
• _layouts
• _posts
• _sass
• _site
• assets
• Jekyll files
• _config.yml
• Gemfile
• Gemfile.lock

Jekyll Directories

• _data
• Well-formatted site data should be placed here. The Jekyll engine will autoload all data files (using either the .yml, .yaml, .json, .csv or .tsv formats and extensions) in this directory, and they will be accessible via `site.data`. If there's a file menu.yml under this directory, then you can access contents of the file through site.data.menu.
• In order work with this directory you should have a clear knowledge with .yml, .yaml, .json, .csv, .tsv

• _includes
• These are the partials that can be mixed and matched by your layouts and posts to facilitate reuse. The liquid tag {% include header.html %} can be used to include the partial in _includes/header.html
• Includes are very useful and it completly removes code redundancy.
• With includes one can create a file once and use anywhere without repeating the same blocks of codes.

• _layouts
• These are the templates that wrap posts and pages. Layouts are chosen on a post-by-post and page-by-page basis in the front matter. The liquid tag {{ content }} is used to inject content into the web page.
• In this theme we have used several layouts for different page structures and post individuals structures.
• Front Matter
• Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:

• _posts
• Your dynamic content, so to speak. The naming convention of these files is important, and must follow the format: YEAR-MONTH-DAY-title.MARKUP. The permalinks can be customized for each post, but the date and markup language are determined solely by the file name.
• Your post can be organized by directories as categories or tags.
• These tags, categories and all post values can be provided through post front matter and are displayed with their layouts.
• Permalinks
• Permalinks are the output path for your pages, posts, or collections. They allow you to structure the directories of your source code different from the directories in your output.

• _sass
• These are sass partials that can be imported into your main.scss which will then be processed into a single stylesheet main.css that defines the styles to be used by your site.
• All css packages can be combined into a package with this sass directory.

• _site
• This is where the generated site will be placed (by default) once Jekyll is done transforming it.

• assets
• Assets directory consist of all the css, js, images and other packages for your site.
• Click here for more information.

Jekyll Files

• _config.yml
• Stores configuration data. Many of these options can be specified from the command line executable but it’s easier to specify them here so you don’t have to remember them.
• Jekyll gives you a lot of flexibility to customize how it builds your site. These options can either be specified in a _config.yml or _config.toml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.

• Gemfile
• A Gem is a bundle of code we can include in Ruby projects. This allows us to take someone else’s code and drop it into our own project.
• Jekyll itself is a Gem as well many Jekyll plugins including jekyll-feed, jekyll-pagination, jekyll-seo-tag and jekyll-archives.
• A Gemfile is Ruby’s dependency management system or in other words, a list of Gems a Ruby project needs to run. We use Gemfiles on Jekyll sites when we have Jekyll plugins.
• A Gemfile requires at least one source which tells us where to download the Gems. Unless we have an advanced use case rubygems.org will be fine.
• Next we specify the Gems we’re using. We can include a version number if want a specific version. It’s important to always include Jekyll in our Gemfile.
• Usually we’d have to also specify our plugin Gems in _config.yml so Jekyll knows about them. We can avoid this by putting our plugin Gems in a “jekyll_plugins” group which Jekyll includes automatically.

• Gemfile.lock
• When we create or change a Gemfile, we need to run bundle install which performs two tasks:
• Creates a Gemfile.lock file if it doesn’t exist. This file is auto-generated and includes all the Gems in Gemfile with the addition of a version number even if it wasn’t specified. This ensures that other people we share the source code to will have the same version of the gems.
• Downloads the gems in Gemfile.lock.
• Usually when we run jekyll we’d do something like this:
• jekyll serve
• When we’re using a Gemfile we need to run Jekyll slightly differently. We might have multiple versions of the jekyll-feed plugin on our machine and if we run jekyll serve, it might use the wrong version. We can solve this using bundle exec which makes only the Gems in the Gemfile available. For example if we want to run jekyll serve we’d run:
• bundle exec jekyll serve
• Click here for more details

Troubleshoot

• After downloading the package we have run 'jekyll serve' on the terminal to run jekyll server.
• If you found any errors or bugs run 'bundle install' to update missing gems for jekyll.
• After doing 'bundle install' it will install all the dependency for the jekyll.
• Try 'jekyll serve' to run the jekyll server. If any error occurs in dependency files try 'bundle exec jekyll serve'.
• It will fix the dependencies and run the server.