Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 2.81 KB

README.md

File metadata and controls

87 lines (69 loc) · 2.81 KB
Raw

WhileTrueCurious

Yet Another Technical Blog..

<import something-cool-here>

This website is built with Jekyll and Mediumish template for Jekyll.

Features

  • Built for Jekyll
  • Compatible with Github pages
  • Featured Posts
  • Index Pagination
  • Post Share
  • Post Categories
  • Prev/Next Link
  • Category Archives (this is not yet compatible with github pages though)
  • Jumbotron Categories
  • Integrations:
    • Disqus Comments
    • Google Analaytics
    • Mailchimp Integration
  • Design Features:
    • Bootstrap v4.x
    • Font Awesome
    • Masonry
  • Layouts:
    • Default
    • Post
    • Page
    • Archive

Contribute (TODO!)

  • Clone the repo.
  • Create a branch off of master and give it a meaningful name (e.g. my-new-wtc-post).
  • Open a pull request on GitHub and describe the feature or fix.

How to Use

If you aren't familiar with Jekyll yet, you should know that it is a static site generator. It will transform your plain text into static websites and blogs. No more databases, slow loading websites, risk of being hacked...just your content. And not only that, with Jekyll you get free hosting with GitHub Pages! This page itself is free hosted on Github with the help of Jekyll and Mediumish template that you're currently previewing. If you are a beginner we recommend you start with Jekyll's Docs{:target="_blank"}.

Using WhileTrueCurious

Download or Fork WhileTrueCurious for Jekyll.

  • In your local project, open _config.yml. If your site is in root, for baseurl, make sure this is set to baseurl: /. Also, change your Google Analytics code, disqus username, authors, Mailchimp list etc.
  • WhileTrueCurious requires 2 plugins:
    • $ gem install jekyll-paginate
    • $ gem install jekyll-archives.
  • Edit the menu and footer copyrights in default.html
  • Start by adding your .md files in _posts. WhileTrueCurious already has a few as an example.
  • YAML front matter
    • featured post - featured:true
    • exclude featured post from "All stories" loop to avoid duplicated posts - hidden:true
    • post image - image: assets/images/mypic.jpg
    • external post image - image: "https://externalwebsite.com/image4.jpg"
    • page comments - comments:true
    • meta description (optional) - description: "this is my meta description"

YAML Post Example:

---
layout: post
title:  "WhileTrueCurious sample post"
author: Mukul Dev
categories: [ Jekyll, tutorial ]
image: assets/images/5.jpg
featured: true
---

YAML Page Example

---
layout: page
title: WhileTrueCurious Template for Jekyll
comments: true
---