Almanac

This repository contains the source code for my (old) personal website built with Jekyll.

Prerequisites • Build & Run • Structure • Refs • Authors • License

Prerequisites

Ruby

Download and install Ruby from this link.

Run the following commands to confirm if the installation was successful:

$ ruby -v
$ gem -v

Jekyll

Run the following command to install Jekyll:

$ gem install bundler jekyll

Build & Run

Clone the repo and cd into the directory:

$ git clone https://github.com/shashwatah/almanac.git
$ cd almanac

Set the port in _config.yml

Run the site:

$ bundle exec jekyll serve

Note: 'bundle exec' is not required unless you are running the website for the first time.

Open a browser and type localhost:port

Structure

Directory Structure

.
├── _data                      
|   ├── binge.yml
|   ├── navingation.yml          
|   ├── projects.yml
|   └── sketches.yml
├── _includes                      
|   ├── footer.html
|   ├── head.html
|   ├── header.html
|   └── scripts.html
├── _pages                       
|   ├── 404.html
|   ├── about.html
|   ├── binge.html
|   ├── journal.html
|   ├── projects.html
|   └── sketches.html
├── _posts
├── _site                        # => Auto generated
├── assets                      
|   ├── images
|   |   ├── binge
|   |   ├── posts
|   |   ├── sketches
|   |   └── almanac.png
|   └── styles
├── _config.yml                  # => Site's configuration
├── Gemfile
└── Gemfile.lock

_data/binge.yml

Example:

- title: Breaking Bad
  location: assets/images/binge/breaking_bad.jpg

_data/projects.yml

Example:

- title: GitWiz
  desc: A singular portal to search for public repos from multiple version control platforms.
  tags:
    - name: Node.js
    - name: TypeScript
    - name: JavaScript
  url: https://gitwiz.herokuapp.com

_data/sketches.yml

Example:

- title: The Mandalorian
  caption: "This is the way."
  location: ./assets/images/sketches/mandalorian.jpg

Refs

• The design is inspired by aweekj's Kiko-plus jekyll theme.

License

MIT License | Copyright (c) 2024 Kumar Shashwat