jekyll-github-repos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6532dc9ada3e92dcc00ecf2c61caba6472211a956330b32abe46a57729e9591
+  data.tar.gz: 9b38bad0d392e92aca4e6d81a58a754224e393b97f09e7c1b203304cb3695bef
+SHA512:
+  metadata.gz: bdd3f09176a1c967ebb85978289e411340fc349865f3acf742b365ad7819b09201714474bc177bd534b3e900cef7f58d9ffe3037c7048507dcfacfffdf90bfd4
+  data.tar.gz: 7fe8b67348f5de43c6729377125a6c9d849a681e3fa011b7641897cc7ac18c4e68640332e037f0cd9cf0d5f073cc450cea953b74115d87cd1b5f7f9dcc70b7a8

data/License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Midhun Devasia
+
+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,51 @@
+# `jekyll-github-repos`: Jekyll Plugin for List Github Repositories 
+
+The GitHub Repositories Jekyll Plugin (`jekyll-github-repos`) is a custom Jekyll generator that fetches and lists GitHub repositories for a specified user. It uses the Octokit gem to interact with the GitHub API and retrieve repository data.
+
+## Installation
+Add the gem to your Jekyll project's Gemfile:
+
+```ruby
+gem 'octokit'
+gem 'jekyll-github-repos', '~> 1.0'
+```
+
+Then, run `bundle install` to install the required gems.
+
+## Configuration
+In your Jekyll project's `_config.yml`, add the following settings:
+
+```yaml
+github_repos:
+  username: your_github_username
+  access_token: your_github_access_token
+```
+
+Replace `your_github_username` and `your_github_access_token` with your actual GitHub username and access token. Ensure that the access token has the necessary permissions to access the repositories.
+
+## Usage
+After configuring the plugin, the GitHub Repositories data will be available in your Jekyll site's `site.data['github_repos']` variable. You can use it in your Liquid templates to display the repositories.
+
+For example, in your Liquid template:
+
+```liquid
+{% for repo in site.data.github_repos %}
+  <h2><a href="{{ repo.url }}">{{ repo.name }}</a></h2>
+  <p>{{ repo.desc }}</p>
+{% endfor %}
+```
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at [github.com/midhundevasia/jekyll-github-repos](https://github.com/midhundevasia/jekyll-github-repos). Please read our [Contributing Guide](CONTRIBUTING.md) for more information.
+
+## About the Author
+This plugin is developed and maintained by Your Name. You can find more of my projects at [midhundev.asia](https://midhundev.asia/projects).
+
+## Support
+For questions, issues, or feature requests, please [open an issue](https://github.com/midhundevasia/jekyll-github-repos/issues).
+
+## Acknowledgements
+Special thanks to the [Octokit](https://github.com/octokit/octokit.rb) gem for providing an easy-to-use Ruby interface for the GitHub API.

data/jekyll-github-repos.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+    spec.name          = 'jekyll-github-repos'
+    spec.version       = Jekyll::GitHubReposVersion::VERSION
+    spec.summary       = 'Jekyll plugin to fetch and list GitHub repositories'
+    spec.description   = 'A Jekyll plugin to fetch and list GitHub repositories in Liquid templates'
+    spec.authors       = ['Midhun Devasia']
+    spec.email         = 'hello@midhundev.asia'
+    spec.homepage      = 'https://github.com/midhundevasia/jekyll-github-repos'
+    spec.license       = 'MIT'
+  
+    spec.files         = Dir['lib/**/*', 'jekyll-github-repos.gemspec', 'README.md', 'License']
+    spec.require_paths = ['lib']
+
+    if spec.respond_to?(:metadata)
+      spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    else
+      raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+    end
+
+    spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+    spec.add_dependency "octokit", ">= 5.6"
+    spec.add_development_dependency "bundler", "~> 1.15"
+
+  end
+  

data/lib/generator.rb

@@ -0,0 +1,31 @@
+module JekyllGithubRepos
+  class Generator < Jekyll::Generator
+    safe true
+    priority :high
+
+    def generate(site)
+      client = Octokit::Client.new(access_token: site.config['github_repos']['access_token'])
+      repos = client.repos(site.config['github_repos']['username'])
+
+      repo_list = repos.map do |repo|
+        {
+          'name' => repo.name,
+          'full_name' => repo.full_name,
+          'url' => repo.html_url,
+          'desc' => repo.description,
+          'created_at' => repo.created_at,
+          'pushed_at' => repo.pushed_at,
+          'updated_at' => repo.updated_at,
+          'homepage' => repo.homepage,
+          'forks_count' => repo.forks_count,
+          'stargazers_count' => repo.stargazers_count,
+          'watchers_count' => repo.watchers_count,
+          'forks' => repo.forks,
+          'open_issues' => repo.open_issues,
+          'watchers' => repo.watchers,
+        }
+      end
+      site.data['github_repos'] = repo_list
+    end
+  end
+end

data/lib/jekyll-github-repos.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "octokit"
+require "generator"
+
+module JekyllGithubRepos
+end

data/lib/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Prevent bundler errors
+module Liquid; class Tag; end; end
+
+module Jekyll
+  class GitHubReposVersion < Liquid::Tag
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-github-repos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Midhun Devasia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: A Jekyll plugin to fetch and list GitHub repositories in Liquid templates
+email: hello@midhundev.asia
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- License
+- README.md
+- jekyll-github-repos.gemspec
+- lib/generator.rb
+- lib/jekyll-github-repos.rb
+- lib/version.rb
+homepage: https://github.com/midhundevasia/jekyll-github-repos
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1.6
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to fetch and list GitHub repositories
+test_files: []