jekyll-github-code 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf7c2830265d7dc0c56dd352412820a1cae0df5289030dc0825da1a9f9c9b5d8
+  data.tar.gz: a14cad52d57785d3b77ff1393dafe6b5ef790d7b48a6cbe01dab65d2a69f24cf
+SHA512:
+  metadata.gz: 3803d1ad25166a79ddc769b4fc1f1b2f3d0a9bcdd851dfb5b7f4bab677a96214d2e98614ef0f1d95e2569e0da2b75030e18cfb6ba10e134ec81eefd1395eed7a
+  data.tar.gz: a99f5ca6f838459883c5ecc0bb96ef4ac98fb7885daf9b81981d128dfce9c635ceffe77c6c3b49d84d99ff9de6665887bb768b17f8e4f0551b141e7955afbcde

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "vendor/bundle"

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-12-12
+
+### Added
+
+- Initial release
+- `{% github_code %}` Liquid tag for embedding GitHub code
+- Support for full file embedding
+- Support for line range selection (`#L5-L15`)
+- Support for single line selection (`#L10`)
+- Automatic language detection based on file extension
+- Copy-to-clipboard button
+- Clickable filename linking to GitHub
+- Dark and light theme support
+- Compatible with Jekyll Chirpy theme
+- Comprehensive test suite
+

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-github-code.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop', '~> 1.57', require: false
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Rodolfo Olivieri
+
+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,245 @@
+# Jekyll GitHub Code
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-github-code.svg)](https://badge.fury.io/rb/jekyll-github-code)
+[![Ruby](https://github.com/r0x0d/jekyll-github-code/actions/workflows/ruby.yml/badge.svg)](https://github.com/r0x0d/jekyll-github-code/actions/workflows/ruby.yml)
+
+A Jekyll plugin that lets you embed code from GitHub repositories directly in your blog posts. Perfect for technical blogs, especially those using the [Chirpy theme](https://github.com/cotes2020/jekyll-theme-chirpy).
+
+## Features
+
+- **Embed full files** from any public GitHub repository
+- **Line range support** - show only specific lines (`#L5-L15`)
+- **Automatic syntax highlighting** based on file extension
+- **Copy button** for easy code copying
+- **Clickable filename** links directly to GitHub
+- **Dark/light mode support** compatible with Chirpy theme
+- **Graceful error handling** with informative messages
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem 'jekyll-github-code'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install jekyll-github-code
+```
+
+### Configure Jekyll
+
+Add the plugin to your `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-github-code
+```
+
+### Add the Styles
+
+Copy the SCSS file to your `_sass` directory or add these styles to your main stylesheet.
+
+You can find the styles in `assets/css/github-code.scss` in this repository.
+
+For Chirpy theme, add to `assets/css/jekyll-theme-chirpy.scss`:
+
+```scss
+@import "github-code";
+```
+
+### Add the JavaScript (optional, for copy button)
+
+Add the contents of `assets/js/github-code.js` to your site's JavaScript, or include it directly:
+
+```html
+<script src="/assets/js/github-code.js"></script>
+```
+
+## Usage
+
+### Basic Usage - Full File
+
+```liquid
+{% github_code owner/repo/blob/branch/path/to/file.py %}
+```
+
+**Example:**
+
+```liquid
+{% github_code r0x0d/toolbox-dev/blob/main/toolbox/environment/fedora-packaging.Containerfile %}
+```
+
+### With Line Range
+
+Show only specific lines:
+
+```liquid
+{% github_code owner/repo/blob/branch/path/to/file.py#L5-L15 %}
+```
+
+**Example:**
+
+```liquid
+{% github_code r0x0d/toolbox-dev/blob/main/toolbox/environment/fedora-packaging.Containerfile#L5-L15 %}
+```
+
+### Single Line
+
+```liquid
+{% github_code owner/repo/blob/branch/path/to/file.py#L10 %}
+```
+
+### Full GitHub URL
+
+You can also use the complete GitHub URL:
+
+```liquid
+{% github_code https://github.com/owner/repo/blob/branch/path/to/file.py %}
+```
+
+## Supported Languages
+
+The plugin automatically detects the language from the file extension:
+
+| Extension | Language |
+|-----------|----------|
+| `.rb` | Ruby |
+| `.py` | Python |
+| `.js` | JavaScript |
+| `.ts` | TypeScript |
+| `.yml`, `.yaml` | YAML |
+| `.md` | Markdown |
+| `.sh` | Bash |
+| `.Dockerfile`, `.Containerfile` | Dockerfile |
+| Others | Uses extension as-is |
+
+## Theme Support
+
+The plugin supports both light and dark themes out of the box, compatible with multiple theme systems:
+
+### Supported Theme Selectors
+
+- `[data-mode="light"]` - Chirpy theme
+- `[data-theme="light"]` - Common theme attribute
+- `.light` - Class-based themes
+- `@media (prefers-color-scheme: light)` - System preference
+
+The default is dark theme. Light theme is automatically applied when any of the above selectors match.
+
+### CSS Variables
+
+You can customize the appearance by overriding CSS variables:
+
+```css
+.github-code-block {
+  --github-code-bg: #0d1117;
+  --github-code-header-bg: #161b22;
+  --github-code-border: #30363d;
+  --github-code-text: #e6edf3;
+  --github-code-text-secondary: #8b949e;
+  --github-code-link: #58a6ff;
+  --github-code-link-hover: #79c0ff;
+  --github-code-copy-hover: #238636;
+}
+```
+
+Light theme values are automatically applied, but you can also customize them:
+
+```css
+[data-mode="light"] .github-code-block {
+  --github-code-bg: #ffffff;
+  --github-code-header-bg: #f6f8fa;
+  --github-code-border: #d0d7de;
+  --github-code-text: #1f2328;
+  --github-code-text-secondary: #656d76;
+  --github-code-link: #0969da;
+  --github-code-link-hover: #0550ae;
+}
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+### Running Tests
+
+```bash
+bundle exec rake test
+```
+
+Or run tests directly:
+
+```bash
+bundle exec ruby -Ilib -Itest test/github_code_test.rb
+```
+
+### Building the Gem
+
+```bash
+bundle exec rake build
+```
+
+### Installing Locally
+
+```bash
+bundle exec rake install
+```
+
+### Releasing
+
+To release a new version:
+
+1. Update the version number in `lib/jekyll-github-code/version.rb`
+2. Update `CHANGELOG.md`
+3. Run `bundle exec rake release`
+
+## Demo
+
+Open `demo.html` in your browser to see a preview of the rendered output with different examples.
+
+## How It Works
+
+1. The Liquid tag parses the GitHub reference (owner/repo/branch/path)
+2. Fetches the raw file content from `raw.githubusercontent.com`
+3. Extracts the specified line range (if provided)
+4. Escapes HTML entities in the code
+5. Renders a styled code block with:
+   - GitHub icon and clickable filename
+   - Copy button
+   - Syntax-highlighted code
+
+## Caching
+
+The plugin fetches code at build time. For production, consider:
+
+- Using Jekyll caching plugins
+- Setting up GitHub Actions with caching
+- Pre-generating static includes for frequently used snippets
+
+## Error Handling
+
+If the code cannot be fetched (e.g., 404, network error), the plugin displays a styled error message instead of breaking the build.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r0x0d/jekyll-github-code.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests for new functionality
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](./LICENSE).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  # RuboCop not available
+end
+
+task default: :test