This website is created using Chirpy Starter and is hosted by GitHub Pages.
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 linkspages
- includes posts and collectionsassets/404.html
- the404
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
assets/lib
- contains self-hosted static-assets
- 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.
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
- run
To create posts
- Use Jekyll Compose commands to work with draft posts and then publish the drafts
- 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
- Cross-platform Favicon support using realfavicongenerator (suggested by Tirthankar): file, @be29e4e
- Increased search results limit: file
- Persistent color scheme across browser sessions, using
localStorage
instead ofsessionStorage
: file - Changed collections directory: @92b83b0
- Larger tooltip size: file, @a0ee300
- Removed avatar-border: @727c8ec, @677ca90