Skip to content
← Back to Documentation

Sinai Sinai

Current Version:1.0.2 — 16 April 2020

Table of Contents


Configurations

Sinai theme comes with different customizations in the _config.yml file:

# Site settings
title:              Sinai
logo:               # Logo image URL
description:        Thoughts, Stories and Ideas
baseurl:            '' # The subpath of your site, e.g. /blog
url:                'https://sinai-jekyll.netlify.com/' # The base hostname & protocol for your site
twitter:            https://twitter.com/aspirethemes
facebook:           https://www.facebook.com/aspirethemes
instagram:          https://www.instagram.com/aspirethemes

markdown:  kramdown
permalink: pretty
paginate:  12
sass:
  style: compressed

plugins:
  - jekyll-paginate
  - jekyll/tagging

include:
  - _pages

exclude:
  - vendor
  - Gemfile
  - Gemfile.lock

# Tags
tag_page_dir:         tag
tag_page_layout:      tag_page
tag_permalink_style:  pretty

# Pages path
defaults:
  - scope:
      path: '_pages'
    values:
      permalink: /:basename:output_ext

Deployment

To run the theme locally, navigate to the theme directory and run bundle install to install the dependencies, then run bundle exec jekyll serve to start the Jekyll server.

I would recommend checking the Deployment Methods page on Jekyll website.


Posts

To create a new post, you can create a new markdown file inside the _posts directory by following the recommended file structure.

The following is a post file with different configurations you can add as an example:

---
layout: post
title: Welcome to Jekyll!
featured: true
tags: [frontpage, jekyll, blog]
image: '/images/welcome.jpg'
---

You can set the author, featured or not, tags, and the post image.

The featured key is to mark the post as a featured post, this will add a simple star icon (☆) to the post card.

featured-post

To keep things more organized, add post images to /images/pages directory, and add page images to /images/pages directory.

To create a draft post, create the post file under the _drafts directory, and you can find more information at Working with Drafts.

For tags, try to not add space between two words, for example, Ruby on Rails, could be something like (ruby-on-rails, Ruby_on_Rails, or Ruby-on-Rails).


Pages

To create a new page, just create a new markdown file inside the _pages directory.

The following is the about.md file that you can find as an example included in the theme with the configurations you can set.

---
layout: page
title: About
image: '/images/pages/about.jpeg'
---

Things you can change are: title and image path.


The navigation on the header will automatically include all the links to the pages you have created.


Disqus Comments

Sinai Theme comes with Disqus comments enabled.

Open _includes/disqus.html file, and change the aspirethemes value on line 15 with your Disqus account shortname.

s.src = '//aspirethemes-demos.disqus.com/embed.js';

So, if your Disqus shortname is exampleone, the final code above should be

s.src = '//exampleone.disqus.com/embed.js';

That’s all you need to set up Disqus from the theme side. If you get any issue that comments are unable to load. First, make sure you have registered your website with Disqus (Step 1)

And also check Disqus troubleshooting guide if you still have issues.


Google Analytics

To integrate Google Analytics, open _includes/analytics.html, and add your Google Analytics code.

Social Media Icons

Social media links are placed in:

  • _includes/social-icons.html

The theme is using Evil Icons, which contains very simple and clean icons. The following is a list of the social media icons to use:

Available Social Media Icons

The theme uses Evil Icons ↗ to provide simple and clean icons for other social accounts. Here you can find a list of the social media icons to use:

Facebook

<span data-icon='ei-sc-facebook' data-size='s'></span>

GitHub

<span data-icon='ei-sc-github' data-size='s'></span>

Instagram

<span data-icon='ei-sc-instagram' data-size='s'></span>

LinkedIn

<span data-icon='ei-sc-linkedin' data-size='s'></span>

Odnoklassniki

<span data-icon='ei-sc-odnoklassniki' data-size='s'></span>

Pinterest

<span data-icon='ei-sc-pinterest' data-size='s'></span>

Skype

<span data-icon='ei-sc-skype' data-size='s'></span>

SoundCloud

<span data-icon='ei-sc-soundcloud' data-size='s'></span>

Telegram

<span data-icon='ei-sc-telegram' data-size='s'></span>

Tumblr

<span data-icon='ei-sc-tumblr' data-size='s'></span>

Twitter

<span data-icon='ei-sc-twitter' data-size='s'></span>

Vimeo

<span data-icon='ei-sc-vimeo' data-size='s'></span>

VK

<span data-icon='ei-sc-vk' data-size='s'></span>

Youtube

<span data-icon='ei-sc-youtube' data-size='s'></span>

Update favicon

You can find the current favicon (favicon.ico) inside the theme root directory, just replace it with your new favicon.


Your feedback is very welcome ♥

I'm open to your feedback and to hear about your experience. If you have about one minute, please send your thoughts through this Google Form ↗.

Thank you for your time!

👋 Support

Have any questions? I'm here to help 😊

Contact Ahmad
Ahmad Ajmi
Ahmad Ajmi