Repository files navigation

• Configurations
• Deployment
• Posts
• Pages
• Navigation
• Disqus Comments
• Social Media Links
• Update favicon

Type theme comes with different customizations in the_config.yml file:

title:       Typeemail:''description:''baseurl:''# The subpath of your site, e.g. /blogurl:''# The base hostname & protocol for your sitetwitter:''github:''instagram:''facebook:''markdown:  kramdownpermalink: prettypaginate:  60sass:  style: compressedgems:  - jekyll-paginate  - jekyll/tagginginclude:  - _pagesexclude:  - vendor  - Gemfile  - Gemfile.lock# Tagstag_page_dir:         tagtag_page_layout:      tag_pagetag_permalink_style:  pretty# Pages pathdefaults:  - scope:      path:'_pages'    values:      permalink: /:basename:output_ext

To run the theme locally, navigate to the theme directory and runbundle install to install the dependencies, then runjekyll serve to start the Jekyll server.

I would recommend checking theDeployment Methods page on Jekyll website.

To create a new post, you can create a new markdown file inside the_posts directory by following therecommended file structure.

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

---layout: posttitle: Welcome to Jekyll!featured:truetags: [frontpage, jekyll, blog]image:'/images/welcome.jpg'---

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

Thefeatured key is to mark the post as a featured post, this will add a simple star icon (*) to the postcard.

To keep things more organized, add post images to/images/posts 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 atWorking 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, orRuby-on-Rails).

Note that tags are not working with GitHub Pages, that's because the usedjekyll-tagging plugin is notwhitelisted by GitHub.

To make this work, I useNetlify.com for deployment.

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

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

---layout: pagetitle: Aboutimage:'/images/pages/about.jpeg'---

Things you can change are:title andimage path.

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

Open_includes/disqus.html file, and change theaspirethemes-demos value on line12 with yourDisqus account shortname.

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

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

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

That's all you need to setup Disqus from the theme side. If you get any issue regarding that comments are unable to load. First, make sure you haveregistered your website with Disqus (Step 1)

And also checkDisqus troubleshooting guide if you still have issues.

Social media links included in_includes/footer.html file.

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

Twitter

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

Facebook

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

Instagram

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

Pinterest

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

Vimeo

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

Google Plus

<spandata-icon='ei-sc-google-plus'data-size='s'></span>

SoundCloud

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

Tumblr

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

Youtube

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

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

👉 Visitaspirethemes.com for more Jekyll, Ghost, and WordPress themes.