Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shashwatah/almanac

(Old) Personal Website/Blog built with Jekyll.
https://github.com/shashwatah/almanac

css html jekyll jekyll-blog jekyll-site liquid liquid-templating-engine personal-blog personal-website portfolio portfolio-website yaml

Last synced: 2 months ago
JSON representation

(Old) Personal Website/Blog built with Jekyll.

Awesome Lists containing this project

README

        




Almanac


Almanac



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


MIT License
Github Release


Prerequisites
Build & Run
Structure
Refs
Authors
License

Gif

## Prerequisites

### Ruby

Download and install Ruby from this [link](https://www.ruby-lang.org/en/downloads/).

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

```bash
$ ruby -v
$ gem -v
```

### Jekyll

Run the following command to install Jekyll:

```bash
$ gem install bundler jekyll
```

## Build & Run

Clone the repo and cd into the directory:

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

> Set the port in *_config.yml*

Run the site:

```bash
$ 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

```bash
.
├── _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:
```yml
- title: Breaking Bad
location: assets/images/binge/breaking_bad.jpg
```

### _data/projects.yml

Example:
```yml
- 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:
```yml
- title: The Mandalorian
caption: "This is the way."
location: ./assets/images/sketches/mandalorian.jpg
```

## Refs

- The design is inspired by [aweekj](https://github.com/aweekj)'s [Kiko-plus](https://github.com/aweekj/Kiko-plus) jekyll theme.

## License

[MIT License](https://github.com/shashwatah/almanac/blob/main/LICENSE) | Copyright (c) 2024 Kumar Shashwat