jekyll-theme-instagram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a982c6a003a07040141cd51005d334dceb20a86943c41c5794a063907d3fb0c
+  data.tar.gz: 15823a90e488887878a6581b5355411a63e441a0a0978852738e5652bbd8cadf
+SHA512:
+  metadata.gz: 37ebe89f76080e799fff34ca96f4fd53c063b90987008284143b63239238a22c57a7d17c2ea60296c6cd408f33566e08b87d79d7b47e5adc22518f48dcf36cad
+  data.tar.gz: 3b6cdab1b13a723b6e93f0f3b6dd575c4684712ba53216037a354e392d3fe7667251bbd8fe732be11554b386b7752689f3496065bcc84bb4a8a3db3caf7a38c0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Diptanil Saha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# jekyll-theme-instagram
+
+A minimalist Jekyll theme for creating an Instagram-inspired user profile page.
+
+This Jekyll theme transforms your blog into an Instagram-like archive, perfect for preserving and showcasing your Instagram content. The home page mimics an Instagram profile, featuring:
+
+- Profile Picture and bio section.
+- Grid layout of post thumbnails.
+
+Ideal for influencers, photographers, or anyone looking to maintain an independent archive of their Instagram content in a familiar, visually appealing format.
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-instagram"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-instagram
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-instagram
+
+
+If you are using Github Pages, add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+remote_theme: diptanilsaha/jekyll-theme-instagram
+```
+
+## Usage
+
+### Global Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `title` | String | --- | The title of the website.[^1] |
+| `name` | String | --- | Website author's name. |
+| `description` | String | --- | Description of the website. |
+| `header_img` | String | --- | URL of the Header Image. |
+| `ig_username` | String | --- | Instagram Username |
+| `ig_category` | String | --- | Category of the Instagram Profile |
+| `ig_website` | String | --- | Website URL on the Instagram Profile. |
+| `footer_website` | String | --- | Other External Website. |
+| `theme_config.archive` | Boolean | `true` | Theme configuration suggesting website is made for Archiving purpose. |
+| `include` | String | --- | Folders you want to include to build Jekyll Site. |
+
+
+### Post Configuration
+
+| Variable | Type | Default | Specification |
+| -------- | ---- | ------- | ------------- |
+| `title` | String | --- | Title of the Post. |
+| `date` | Date | --- | Date of the Post. |
+| `archive_date` | Date | --- | Archive Date of the Post.[^2] |
+| `thumbnail` | String | --- | URL of the Thumbnail Image |
+| `media` | List | --- | Array of Hashes of Media for the Post, where each hash defines type and URL of Media. |
+
+
+[^1]: Use Instagram username, if using for archiving Instagram Account.
+
+[^2]: If `theme_config.archive` is set to `true`, it is mandatory to add `archive_date` on post configuration. Otherwise, not necessary.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diptanilsaha/jekyll-theme-instagram. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-instagram.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,25 @@
+title: jekyll-theme-instagram
+name: Jekyll Theme Instagram
+description: 'A minimalist Jekyll theme for creating an Instagram-inspired user profile page.'
+url: https://diptanil.page
+baseurl: "/jekyll-theme-instagram"
+header_img: /media/jekyll-theme-instagram.png
+
+ig_username: 
+ig_category: Jekyll Theme
+ig_website: github.com/diptanilsaha/jekyll-theme-instagram/
+
+footer_website: diptanil.page
+
+favicon: /media/favicon.ico
+
+theme: jekyll-theme-instagram # if you are using GitHub Pages, change it to remote_theme: diptanilsaha/jekyll_theme_instagram
+
+theme_config:
+  archive: true
+
+include:
+  - media
+
+sass:
+  style: :compressed

data/_includes/footer.html

@@ -0,0 +1,34 @@
+{%- assign error = false -%}
+{%- assign message = "" -%}
+
+{%- if site.posts.size > 0 -%}
+{%- if site.theme_config.archive -%}
+{%- if site.posts.first.archive_date == nil -%}
+{%- assign error = true -%}
+{%- assign message = "Error: Archive Date is missing in your latest post. " -%}
+{%- else -%}
+{%- assign message = site.posts.first.archive_date | date_to_string -%}
+{%- endif -%}
+{%- else -%}
+{%- if site.posts.first.date == nil -%}
+{%- assign message = "Error: Date is missing in your latest post. " -%}
+{%- else -%}
+{%- assign message = site.posts.first.date | date_to_string -%}
+{%- endif -%}
+{%- endif -%}
+{%- endif -%}
+
+<footer class="footer">
+    <div class="last-updated">
+        last updated:&nbsp;
+        {%- if error -%}
+        <span style="color: red;">{{ message }}</span>
+        {%- else -%}
+        {{ message }}
+        {%- endif -%}
+    </div>
+    <div class="links">
+        <div>{{ site.footer_website }}</div>
+        <div>Follow <a href="https://instagram.com/{{ site.ig_username }}" target="_blank">{{ site.ig_username }}</a> on Instagram</div>
+    </div>
+</footer>

data/_includes/head.html

@@ -0,0 +1,15 @@
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    
+    <title>
+        {%- if page.title -%}
+            {{ page.title }} - {{ site.title }}
+        {%- else -%}
+            {{ site.title }}
+        {%- endif -%}
+    </title>
+
+    <link rel="shortcut icon" type="image/x-icon" href="{{ site.favicon | relative_url }}" />
+    <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}">
+</head>

data/_includes/header.html

@@ -0,0 +1,51 @@
+{%- if page.layout == "home" -%}
+    <header class="profile">
+        <section class="profile-img">
+            <img src="{{ site.header_img | relative_url }}" alt="{{ site.title }}">
+        </section>
+        <section class="profile-username">
+            <div class="username">{{ site.title }}</div>
+            <a class="btn" href="https://instagram.com/{{ site.ig_username }}" target="_blank">Follow on Instagram</a>
+        </section>
+        <section class="profile-details">
+            {%- if site.name -%}
+            <div class="name">{{ site.name }}</div>
+            {%- endif -%}
+
+            {%- if site.ig_category -%}
+            <div class="category">{{ site.ig_category }}</div>
+            {%- endif -%}
+
+            {%- if site.description -%}
+            <div class="description">{{ site.description | newline_to_br }}</div>
+            {%- endif -%}
+
+            {%- if site.ig_website -%}
+            <div class="website">
+                <div class="icon">
+                    <svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+                        stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+                        <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71" />
+                        <path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71" />
+                    </svg>
+                </div>
+                <div class="text">
+                    <a href="http://{{ site.ig_website }}" target="_blank">{{ site.ig_website }}</a>
+                </div>
+            </div>
+            {%- endif -%}
+        </section>
+    </header>
+{%- else -%}
+    <header>
+        <nav class="navbar">
+            <a href="{{ "/" | relative_url }}" class="back">
+                <svg width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+                    <path d="M15 4l-8 8 8 8" stroke="#000000" stroke-width="2" fill="none" stroke-linecap="round"
+                        stroke-linejoin="round" />
+                </svg>
+            </a>
+            <div class="text">{{ site.title }}</div>
+        </nav>
+    </header>
+{%- endif -%}

data/_includes/media.html

@@ -0,0 +1,5 @@
+{%- if include.type == 'video' -%}
+    <video class="media" src="{{ include.src | relative_url }}" controls autoplay></video>
+{%- else -%}
+    <img class="media" src="{{ include.src | relative_url }}" >
+{%- endif -%}

data/_layouts/default.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+    {%- include head.html -%}
+
+    <body>
+        <div class="container">
+            
+            {%- include header.html -%}
+
+            <main class="main">
+                {{ content }}
+            </main>
+
+            {%- include footer.html -%}
+
+        </div>
+    </body>
+
+</html>

data/_layouts/home.html

@@ -0,0 +1,22 @@
+---
+layout: default
+---
+
+{%- assign posts = site.posts -%}
+
+{%- if posts.size > 0 -%}
+<div class="posts">
+    {%- for post in posts -%}
+    <div class="post">
+        <a href="{{ post.url | relative_url }}">
+            <div class="thumbnail">
+                <img src="{{ post.thumbnail | relative_url }}">
+                <div class="overlay">
+                    <div class="title">{{ post.title }}</div>
+                </div>
+            </div>
+        </a>
+    </div>
+    {%- endfor -%}
+</div>
+{%- endif -%}

data/_layouts/post.html

@@ -0,0 +1,59 @@
+---
+layout: default
+---
+
+{% assign error = false %}
+{% assign error_message = "" %}
+
+{%- if page.title == nil -%}
+    {%- assign error = true -%}
+    {%- assign error_message = error_message | append: "Error: Title is missing in frontmatter. " -%}
+{%- endif -%}
+
+{%- if page.date == nil -%}
+    {%- assign error = true -%}
+    {%- assign error_message = error_message | append: "Error: Date is missing in frontmatter. " -%}
+{%- endif -%}
+
+{%- if page.thumbnail == nil -%}
+    {%- assign error = true -%}
+    {%- assign error_message = error_message | append: "Error: Thumbnail is missing in frontmatter. " -%}
+{%- endif -%}
+
+{%- if site.theme_config.archive and page.archive_date == nil -%}
+    {%- assign error = true -%}
+    {%- assign error_message = error_message | append: "Error: Archive Date is missing in frontmatter. " -%}
+{%- endif -%}
+
+{%- if error -%}
+<div style="color: red; font-weight: bold;">
+    {{ error_message }}
+    <p>File: {{ page.path }}</p>
+</div>
+{%- else -%}
+
+<div class="post-container">
+    <div class="title">{{ page.title }}</div>
+    <div class="date">Posted on: {{ page.date | date_to_string }}</div>
+    {% if site.theme_config.archive -%}
+    <div class="archive-date">Archived on: {{ page.archive_date | date_to_string }}</div>
+    {%- endif -%}
+    <hr>
+
+    {%- assign media = page.media -%}
+
+    {%- if media.size > 0 -%}
+    <ul class="media-list">
+        {%- for item in media -%}
+        <li>
+            
+            {%- include media.html src=item.url type=item.type -%}
+
+        </li>
+        {%- endfor -%}
+    </ul>
+    {%- endif -%}
+
+    {{ content | newline_to_br }}
+</div>
+{%- endif -%}

data/_sass/jekyll-theme-instagram.scss

@@ -0,0 +1,339 @@
+html, body {
+    height: 100%;
+    margin: 0;
+}
+
+body {
+    font-family: Arial, Helvetica, sans-serif;
+}
+
+a {
+    color: #007bff;
+}
+
+.container {
+    max-width: 900px;
+    margin: 0 auto;
+    padding: 0 15px;
+    display: flex;
+    flex-direction: column;
+    min-height: 100vh;
+}
+
+.btn {
+    background-color: #007bff;
+    color: white;
+    padding: 7px 14px;
+    border: none;
+    border-radius: 4px;
+    font-size: 14px;
+    cursor: pointer;
+    text-decoration: none;
+}
+
+.profile {
+    display: grid;
+    grid-template-columns: 1fr 2fr;
+    margin: 2rem 0rem;
+}
+
+.navbar {
+    display: flex;
+    align-items: center;
+    margin-top: 2rem;
+
+    .back {
+        width: 30px;
+        height: 30px;
+        display: flex;
+        align-items: center;
+    }
+
+    .text {
+        margin: 0 auto;
+        font-size: 1.5rem;
+        font-weight: 400;
+    }
+}
+
+.profile-img {
+    grid-row: 1 / 3;
+    grid-column: 1 / 2;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+
+    img {
+        max-width: 100%;
+        width: 140px;
+        height: auto;
+        border-radius: 50%;
+        border: solid 1px #979797;
+        border-width: thin;
+    }
+}
+
+.profile-username {
+    grid-row: 1 / 2;
+    grid-column: 2 / 3;
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    padding-right: 4px;
+
+    .username {
+        font-size: 2rem;
+        font-weight: bold;
+        inline-size: 400px;
+        overflow: hidden;
+        white-space: nowrap;
+        text-overflow: ellipsis;
+    }
+}
+
+.profile-details {
+    grid-row: 2 / 3;
+    grid-column: 2 / 3;
+    margin-top: 10px;
+
+    .name {
+        font-size: 1rem;
+        font-weight: 600;
+        margin-bottom: 5px;
+    }
+
+    .category {
+        font-size: 1rem;
+        font-weight: 400;
+        color: #707070;
+        margin-bottom: 5px;
+    }
+
+    .description {
+        font-size: 1rem;
+        font-weight: 300;
+        margin-bottom: 5px;
+    }
+
+    .website {
+        display: flex;
+        flex-direction: row;
+        align-items: center;
+        color: #002fff;
+
+        .icon {
+            width: 1rem;
+            height: 1rem;
+            margin-right: 5px;
+        }
+
+        .text {
+            inline-size: 100%;
+            overflow: hidden;
+            white-space: nowrap;
+            text-overflow: ellipsis;
+        }
+
+        a {
+            color: #002fff;
+            text-decoration: none;
+        }
+
+        &:hover a{
+            text-decoration: underline;
+        }
+    }
+}
+
+.main {
+    flex: 1 0 auto;
+}
+
+.footer {
+    flex-shrink: 0;
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    padding: 1rem 0rem;
+
+    .last-updated {
+        color: #707070;
+    }
+
+    .links {
+        text-align: end;
+    }
+}
+
+.posts {
+    margin-top: 1rem;
+    margin-bottom: 1rem;
+    display: flex;
+    flex-wrap: wrap;
+
+    .post {
+        width: 33.333%;
+        padding: 0.25rem;
+        box-sizing: border-box;
+    }
+}
+
+.thumbnail {
+    position: relative;
+    width: 100%;
+    padding-bottom: 100%;
+
+    img {
+        position: absolute;
+        top: 0;
+        left: 0;
+        width: 100%;
+        height: 100%;
+        object-fit: cover;
+    }
+
+    &:hover .overlay {
+        display: flex;
+        background: rgba(0, 0, 0, 0.5);
+    }
+}
+
+.overlay {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    display: none;
+    justify-content: center;
+    align-items: center;
+    background: rgba(0, 0, 0, 0);
+    color: white;
+    font-size: 20px;
+    font-weight: bold;
+    transition: background 0.3s ease;
+    text-align: center;
+
+    .title {
+        inline-size: 80%;
+        overflow: hidden;
+        white-space: nowrap;
+        text-overflow: ellipsis;
+    }
+}
+
+.post-container {
+    max-width: 80%;
+    margin: 1.5rem auto;
+
+    .title {
+        font-size: 1.856rem;
+        font-weight: 700;
+        margin-bottom: 0.6rem;
+    }
+
+    .date {
+        margin-bottom: 0.4rem;
+    }
+
+    .archive-date {
+        color: #707070;
+    }
+
+    hr {
+        border: none;
+        border-top: 0.5px solid #929292;
+    }
+
+    p {
+        font-size: 1.2rem;
+    }
+}
+
+.media-list {
+    list-style-type: none;
+    padding-left: 0%;
+
+    li {
+        margin: 1rem 0rem;
+    }
+}
+
+.media {
+    width: 100%;
+    height: auto;
+    object-fit: contain;
+}
+
+@media (max-width: 900px) {
+    .container {
+        max-width: 100%;
+    }
+}
+
+@media (max-width: 700px) {
+    .profile-img {
+        grid-row-end: 2;
+
+        img {
+            width: 77px;
+        }
+    }
+
+    .profile-details {
+        grid-row: 2 / 3;
+        grid-column: 1 / 3;
+        margin-top: 10px;
+    }
+
+    .profile-username {
+        flex-direction: column;
+        justify-content: center;
+        padding: 0px;
+
+        .username {
+            inline-size: 200px;
+            overflow: hidden;
+            white-space: nowrap;
+            text-overflow: ellipsis;
+            text-align: center;
+            font-size: 1.5rem;
+            margin-bottom: 0.8rem;
+        }
+    }
+    
+    .footer {
+        flex-direction: column;
+        justify-content: center;
+
+        .links {
+            margin-top: 10px;
+            text-align: center;
+        }
+    }
+
+    .posts {
+        margin: 0rem -0.5rem 1rem -0.5rem;
+    }
+
+    .navbar {
+        margin: 1.5rem 0rem;
+
+        .text {
+            text-align: center;
+            inline-size: 80%;
+            overflow: hidden;
+            white-space: nowrap;
+            text-overflow: ellipsis;
+        }
+    }
+
+    .post-container {
+        max-width: 100%;
+        margin-top: 0rem;
+
+        p {
+            font-size: 1rem;
+        }
+    }
+}

data/assets/css/main.scss

@@ -0,0 +1,4 @@
+---
+---
+
+@import "jekyll-theme-instagram";

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-instagram
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diptanil Saha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: 
+email:
+- diptanil.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- _config.yml
+- _includes/footer.html
+- _includes/head.html
+- _includes/header.html
+- _includes/media.html
+- _layouts/default.html
+- _layouts/home.html
+- _layouts/post.html
+- _sass/jekyll-theme-instagram.scss
+- assets/css/main.scss
+homepage: https://github.com/diptanilsaha/jekyll-theme-instagram/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: A minimalist Jekyll theme for creating an Instagram-inspired user profile
+  page.
+test_files: []