Skip to content

paramrathour/blog

Repository files navigation

Wrath's blog

Gem Version 

This website is created using Chirpy Starter and is hosted by GitHub Pages.

Repository Structure

This repository contains only critical files used for making the blog, i.e., only the following kind of files

  • content files (blog data and personal information)
    • _config.yml - configuration of the site
    • _data - includes contacts and sharing links
    • pages - includes posts and collections
    • assets/404.html - the 404 error page
  • select design files (possibly modified) from the GitHub fork of the current gem version
    • _includes
    • _layouts
    • _sass
    • assets/js
    • _plugins
    • .github/workflows
  • submodule
  • also, media assets such as images and documents are stored in a separate repository called website-assets.

This separation allows user to focus on writing blogs while keeping away

  • the design files which allows easier version upgrade.
  • the media assets which reduces size of this repository.

Usage

To build the website

  • Install Jekyll and Git
  • Clone the repository using git clone --recursive https://github.com/paramrathour/blog
  • In the repository directory,
    • run bundle to install dependencies
    • run bundle exec jekyll serve and open the website locally using the displayed URL

To create posts

  • Use Jekyll Compose commands to work with draft posts and then publish the drafts

Features

Added

  • Toggle paginator_enable in the _config.yml to enable/disable pagination: @c8a9dc1
  • Post description in search results: file
  • 404 page file
  • Reading time and last modified date on the home page: file, @8237eed, @4c3137c

Modified