rawfeed 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b4a5c7ff703bd0049e8713cc0d08a73698657b85a0cccbf687545cb63d5476e
-  data.tar.gz: 1787cc1fcda221d1aad7fa838abaecb625428c6ea03f81a7b2e08b7d4976eaf1
+  metadata.gz: 7bc7fabfbbdda6f7e13515d95b93709380ba33843e15d0e8d2ffc97ccdcde0bf
+  data.tar.gz: 65458a1de15baca3179cb73cadd8f843183e1327032e6630add6562a130beaa2
 SHA512:
-  metadata.gz: eb0bea3dd530c918108078babc853563f0a404801807f56dbcff81694b26812f6e9edb09b49b11e6a00db175ffd84b92efe363260b1d6a5a81ff142c4f2c3ffe
-  data.tar.gz: '0251043911fc99d55b9b45d0cf991fb350f5ba6f3902bdbfce97f1919c221f86041ac4a46f03284888e74207d73036661da45768ecc924eec0407a052b8d4687'
+  metadata.gz: c304baba91ec1b737d0a83a9f43561408078d463815bffec9643f671d53c272bcadd1663bdf5593e1d23a1b4e68b9a1563c6c6358dfebe2a45b91f241056d9f8
+  data.tar.gz: b05efb524b14043537d04cc2022924c4228706a0b21742c5ca3f9a27c474ee32fe00aea62d00595c0d19468131610b2910537f1da5e68e07924d0d21db23bfce

data/.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 80
+
+[*.{md,markdown}]
+max_line_length = 100
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab
+max_line_length = 100
+
+[LICENSE]
+indent_style = tab
+indent_size = 4

data/.gitignore

@@ -0,0 +1,19 @@
+.rspec_status
+_site/
+.site_build/
+tmp/
+node_modules/
+.bundle-cache/
+.sass-cache/
+.jekyll-cache/
+rawfeed-*/
+.jekyll-metadata/
+pkg/
+!.vscode/
+
+~*
+*.Identifier
+*.bak
+.log
+*.gem
+.envrc

data/.gitlab/ci/gitlab-pages.yml

@@ -0,0 +1,51 @@
+# --------------------------------Note-----------------------------------------
+
+# 1. This action will be copied to the end-user (production) project. It has no purpose for
+# development.
+
+# 2. Usage:
+# To enable this CI, create the .gitlab-ci.yml file in the project root and add the following content:
+
+# include:
+#   - local: .gitlab/ci/gitlab-pages.yml
+
+# ------------------------------------------------------------------------------
+
+### --- Dear user, uncomment this block if you want to publish the site on GitLab Pages.
+
+# image: node:20-alpine
+
+# cache:
+#   paths:
+#     - .bundle-cache/
+
+# stages:
+#   - build
+#   - deploy
+
+# # A job that installs dependencies and compiles the website
+# build_job:
+#   stage: build
+#   script:
+#     - apk add --no-cache ruby ruby-dev
+#     - gem install bundler
+#     # - bundle config set --local path '.bundle-cache'
+#     - bundle install
+#   artifacts:
+#     paths:
+#       - _site/
+#   only:
+#     - main
+
+# # A job that deploys compiled files to GitLab Pages
+# pages:
+#   stage: deploy
+#   script:
+#     - mv _site/ public/
+#   artifacts:
+#     paths:
+#       - public
+#   only:
+#     - main
+
+### --- Dear user, uncomment this block if you want to publish the site on GitLab Pages.

data/.hidden

@@ -0,0 +1,6 @@
+package-lock.json
+Gemfile.lock
+404.html
+node_modules
+package.json
+Gemfile

data/404.html

@@ -0,0 +1,6 @@
+---
+layout: error
+permalink: /404.html
+---
+
+<!-- Nothing needs to be added here. -->

data/Gemfile

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+## [ rawfeed ] Do not modify this block unless you know what you are doing.
+if ENV["RAWFEED_DEV_PATH"] && File.directory?(ENV["RAWFEED_DEV_PATH"])
+  gem "rawfeed", path: ENV["RAWFEED_DEV_PATH"]
+else
+  ## --- To update rawfeed-jekyll, simply update the version here ---
+  gem "rawfeed", "~> 1.0.0"
+end
+
+# Core
+gem "jekyll", ">= 4.0", "< 5.0"
+gem "rake", "~> 13.0"
+
+# Jekyll plugins
+group :jekyll_plugins do
+  gem "jekyll-sitemap", "~> 1.4"
+  gem "jekyll-feed", "~> 0.17.0"
+  gem "jekyll-archives", "~> 2.3.0"
+  gem "jekyll-paginate-v2", "~> 3.0.0"
+end
+
+# Utilities
+gem "colorize", "~> 1.1.0"
+gem "logger", "~> 1.4"
+gem "rubyzip", "~> 2.3"
+
+# Build and minification
+gem "uglifier", "~> 4.2.0"
+
+# Windows and JRuby
+platforms :windows, :jruby do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Windows file watcher
+gem "wdm", "~> 0.1.1", platforms: [:windows]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+# Development dependencies
+group :development, :test do
+  gem "rspec", "~> 3.12"
+  gem "github_changelog_generator", "~> 1.8"
+  gem "faraday-retry", "~> 1.0"
+end

data/README.md

@@ -1,65 +1,141 @@
 <p align="center">
   <img src=".github/logo.png" alt="Rawfeed" width="150">
   <br>
-  <small>rawfeed-jekyll — A raw Jekyll theme for minimalists</small>
-  <br>
-  <a href="https://badge.fury.io/rb/rawfeed" target="_blank"><img src="https://badge.fury.io/rb/rawfeed.svg" alt="Gem Version" height="18"></a>
+  <small>rawfeed-jekyll — A batteries-included Jekyll framework and CLI</small>
+  <br><br>
+  <a href="https://badge.fury.io/rb/rawfeed" target="_blank"><img src="https://badge.fury.io/rb/rawfeed.svg" alt="Gem Version"></a>
+  <a href="https://github.com/rawfeed/rawfeed-jekyll/actions/workflows/ci.yml" target="_blank"><img src="https://github.com/rawfeed/rawfeed-jekyll/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://rubygems.org/gems/rawfeed" target="_blank"><img src="https://img.shields.io/gem/dt/rawfeed?label=downloads" alt="RubyGems Downloads"></a>
+  <a href="https://rubygems.org/gems/rawfeed" target="_blank"><img src="https://img.shields.io/badge/ruby-%3E%3D%203.0-ruby" alt="Ruby >= 3.0"></a>
+  <a href="LICENSE" target="_blank"><img src="https://img.shields.io/badge/license-MIT-blue" alt="License MIT"></a>
   <br>
+  <a href="https://github.com/rawfeed/rawfeed-jekyll/issues" target="_blank"><img src="https://img.shields.io/github/issues/rawfeed/rawfeed-jekyll" alt="GitHub Issues"></a>
+  <a href="https://github.com/rawfeed/rawfeed-jekyll/pulls" target="_blank"><img src="https://img.shields.io/github/issues-pr/rawfeed/rawfeed-jekyll" alt="GitHub Pull Requests"></a>
+  <a href="https://www.rubydoc.info/gems/rawfeed" target="_blank"><img src="https://img.shields.io/badge/docs-rubydoc-blue" alt="RubyDoc"></a>
+  <br><br>
   <a href="https://rawfeed.github.io/rawfeed-jekyll" target="_blank">Documentation</a>
 </p>
 
-# For developer
+# rawfeed-jekyll
+
+**rawfeed-jekyll** is a batteries-included Jekyll framework and CLI for Ruby 3.x. It provides a modern workflow for site creation, theme distribution, content management, and gem-based package delivery.
+
+## Project resources
+
+- [CONTRIBUTING.md](CONTRIBUTING.md)
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+- [CHANGELOG.md](CHANGELOG.md)
+- [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md)
+- `.github/ISSUE_TEMPLATE/`
+- `.github/pull_request_template.md`
+- `.github/release_template.md`
 
 ## Requirements
 
 | Required | Version | How to verify | How to install                    |
 | -------- | ------- | ------------- | --------------------------------- |
-| Git      | >= 2    | `git -v`      | [Git](http://git-scm.com/)        |
 | Ruby     | >= 3.0  | `ruby -v`     | [Ruby](https://www.ruby-lang.org) |
-| Gem      | >= 3.0  | `gem -v`      | **Ruby** contains **Gem**         |
+| Gem      | >= 3.0  | `gem -v`      | Bundled with Ruby                 |
 | Bundler  | >= 2.0  | `bundler -v`  | `gem install bundler`             |
-| NodeJs   | >= 20   | `node -v`     | [NodeJS](https://nodejs.org)      |
-| Npm      | >= 9    | `npm -v`      | **NodeJS** contains **Npm**       |
 
+## Install
+
+See the full documentation at [https://rawfeed.github.io/rawfeed-jekyll/](https://rawfeed.github.io/rawfeed-jekyll/).
 
-## Clone
+## Developer setup
 
 ```shell
-git clone https://github.com/rawfeed/rawfeed-jekyll.git "rawfeed"; cd rawfeed; npm install
+git clone https://github.com/rawfeed/rawfeed-jekyll.git
+cd rawfeed-jekyll
+export RAWFEED_DEV_PATH="$PWD"
+bundle install
+bundle exec rawfeed serve
 ```
 
-## Gem
+> [!TIP]
+>
+> ### Using direnv
+>
+> ```bash
+> echo "export RAWFEED_DEV_PATH=\"\$PWD\"" > .envrc
+> direnv allow
+> ```
+
+## Contribution workflow
+
+This repository includes GitHub templates for issues and pull requests.
+
+- Bug reports: `.github/ISSUE_TEMPLATE/bug_report.md`
+- Feature requests: `.github/ISSUE_TEMPLATE/feature_request.md`
+- Pull requests: `.github/pull_request_template.md`
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the complete contributor workflow, release process, and code guidelines.
+
+## Release process
+
+The release workflow is documented in [RELEASE_CHECKLIST.md](RELEASE_CHECKLIST.md) and [CHANGELOG.md](CHANGELOG.md).
+
+- Version is defined in `lib/rawfeed/core/version.rb`
+- Package metadata is in `rawfeed.gemspec`
+- CI is configured in `.github/workflows/ci.yml`
+- Release notes are captured by `.github/release_template.md`
+- Release branches should follow `release/<version>` and use `RELEASE_CHECKLIST.md` as the release branch base
+- Changelog automation can be done with `github_changelog_generator` in development
 
-**(1)** - Compile the gem:
+## Continuous integration
+
+This repository uses GitHub Actions to run the complete release workflow on pull requests to `main` and on pushes to `main` or `release/**` branches.
+
+The CI job performs:
+
+- `bundle install` with Bundler cache
+- library loading validation via `bundle exec ruby -Ilib -e 'require "rawfeed"'
+- `bundle exec rspec` for test coverage
+- `bundle exec rawfeed build --destination .site_build` to ensure the theme builds cleanly
+- `gem build rawfeed.gemspec` to verify package creation
+
+## Changelog generation
+
+This repository includes a development tool to help generate changelogs from GitHub issues and tags.
+The project is configured in `.github_changelog_generator`, which uses `key=value` pairs (one per line) — **not** the CLI `--flag value` format.
+By default, the tool generates or updates `CHANGELOG.md` in the repository root.
+
+Use the following command after installing development dependencies:
 
 ```shell
-npm run generate:gem
+bundle exec github_changelog_generator
 ```
 
-**(2)** - Publish the gem:
+If you prefer a manual approach, keep editing `CHANGELOG.md` by hand.
+
+## Build and publish
+
+Build the gem package:
 
 ```shell
-npm run publish:gem
+bundle exec rake build
 ```
 
-For more tasks, see: `npm run rake:tasks`
+Publish the gem to RubyGems:
+
+```shell
+gem push rawfeed-<VERSION>.gem
+```
 
-# Changelog
+## Changelog
 
-See [here](https://rawfeed.github.io/rawfeed-jekyll/changelog/)
+The project changelog is maintained in [CHANGELOG.md](CHANGELOG.md).
 
-# License
+## License
 
-The theme is available as open source under the terms of [this License](https://rawfeed.github.io/rawfeed-jekyll/license/).
+This project is released under the terms of [this license](https://rawfeed.github.io/rawfeed-jekyll/license/).
 
-# Donation
+## Donate
 
-Click on the image below to be redirected to the donation forms:
+If you appreciate this project, consider supporting development.
 
-<div class="donation">
+<div class="donate">
   <a href="https://williamcanin.github.io/donate/" target="_blank">
-    <img width="160" height="100" src="assets/images/icons/donation.svg" alt="Donate"/>
+    <img width="160" height="100" src="https://williamcanin.github.io/assets/images/icons/donate.svg" alt="Donate"/>
   </a>
 </div>
-
-> It is very important that you make a donation to motivate further development of rawfeed-jekyll. :)

data/_config.yml

@@ -0,0 +1,77 @@
+# [ important!!! ] the base hostname & protocol for your site, e.g. http://example.com
+url: ""
+
+# the subpath of your site, e.g. /blog
+baseurl: ""
+
+# ---------- CAUTION!!! DO NOT move from here unless you REALLY know what you are doing. -----------
+
+theme: rawfeed
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+  - jekyll-archives
+  - jekyll-paginate-v2
+  - rawfeed
+collections:
+  pixels:
+    output: true
+    permalink: /pixels/:title/
+pagination:
+  enabled: true
+  debug: false
+  collection: "posts"
+  sort_field: "date"
+  sort_reverse: true
+  per_page: 50
+  permalink: "/page/:num/"
+  locale: ""
+  title: ":title - Page :num"
+  limit: 0
+feed:
+  path: /feed.xml
+defaults:
+  - scope:
+      path: "_posts"
+      type: "posts"
+    values:
+      published: true
+  - scope:
+      path: "_pixels"
+      type: "pixels"
+    values:
+      published: true
+jekyll-archives:
+  enabled:
+    - tags
+  layouts:
+    tag: blog/posts_by_tag
+  permalinks:
+    tag: "/blog/tags/:name/"
+include: ["_pages"]
+permalink: "/blog/:title/"
+markdown: kramdown
+kramdown:
+  input: GFM
+  syntax_highlighter: rouge
+  # syntax_highlighter_opts:
+  #   line_numbers: true
+sass:
+  sass_dir: _sass
+  style: compressed
+exclude:
+  - .bundle-cache
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+
+  # files below: developer mode
+  - node_modules
+  - docs
+  - exe
+  - rawfeed.gemspec
+  - CODE_OF_CONDUCT.md
+  - LICENSE
+  - tmp
+  - lib
+  - pkg

data/_data/generic.yml

@@ -0,0 +1,29 @@
+# Rawfeed - Technical Configuration
+# This file contains core technical settings for the Jekyll theme
+
+title: rawfeed
+author: "William C. Canin"
+
+# Here you change the language of the months of the date
+datelang:
+  format: "%b %d, %Y"
+  lang: "en_US" # en_US | pt_PT | jp_JP | ch_CH | es_ES | fr_FR | it_IT | de_DE | ru_RU
+
+default:
+  lang: en-US
+  # Some compatible separators: ⨟∫⦁;⬨⬖︙︰𐄛🢝
+  separator: ⨟
+  width: 860 # default: 860
+  background_focus: true
+  rounding: false
+  user_select: none # none | text
+  font:
+    # Fonts Style Options: [default: monospace]
+    # "'Ubuntu', sans-serif"
+    # "'Inconsolata', monospace"
+    # "'JetBrains Mono', monospace"
+    # "'Roboto Mono', monospace"
+    # "'Open Sans', sans-serif"
+    style: monospace
+    size: 16.34px
+    spacing: -0.05em

data/_data/screen/blog.yml

@@ -0,0 +1,46 @@
+# Rawfeed - Blog Page Content & Texts
+
+# section: [blog]
+blog:
+  subtitle: "posts"
+  search:
+    enable: true
+    placeholder: "type here to search for a post or Esc to exit"
+    button_clean:
+      text: "clean"
+    results: "results"
+    no_results: "No results found"
+  pagination:
+    newer_text: "newer posts"
+    counter: ["page", "of"]
+    older_text: "older posts"
+  post:
+    reading_time:
+      enable: true
+      words_per_minute: 180
+      message:
+        ["Read this post in approximately", "Read this post in less than"]
+      minutes_label: ["minute", "minutes"]
+    author: "Posted by"
+    related_posts:
+      enable: true
+      title: "related posts"
+    updated_on: "Post updated on"
+    comments:
+      title: "comments"
+      provider: "giscus" # choose between. options: giscus | disqus.
+      giscus:
+        repo: "" # your repository, e.g: username/repo-name
+        repo_id: "" # copied from giscus.app, e.g: R_kgD...
+        repo_category: "" # copied category name GitHub
+        category_id: "" # copied from giscus.app, e.g: DIC_kwD...
+        mapping: "pathname"
+        reactions_enabled: 1
+        theme: "light" # initial theme. default: light
+        theme_light: "noborder_light" # light theme. default: noborder_light
+        theme_dark: "noborder_gray" # dark theme. default: noborder_gray
+        lang: "en" # en,pt,..
+      disqus:
+        shortname: "" # your shortname disqus
+    posts_by_tags:
+      title: "posts by tag"

data/_data/screen/contact.yml

@@ -0,0 +1,31 @@
+# Rawfeed - Contact Page Content & Texts
+
+# section: [contact]
+contact:
+  name:
+    placeholder: "first and last name"
+  email:
+    placeholder: "your best email address"
+    help: "we'll never share your email with anyone else."
+  message:
+    placeholder: "write your message here"
+    status: "sending...wait"
+    characters:
+      min: 50
+      warning:
+        title: "Warning"
+        content: "the message must have at least 50 characters."
+    success:
+      title: "Message sent"
+      content: "your message has been sent successfully!"
+    error:
+      title: "Error"
+      content: "something went wrong while sending your message."
+  button:
+    text: "send!"
+  recaptcha:
+    warning:
+      title: Warning
+      content: "Please tick the 'I'm not a robot' box."
+    fail: "Verification failed. Please reload the page and try again."
+    error: "An error occurred while sending the message. Please try again."

data/_data/screen/donate.yml

@@ -0,0 +1,45 @@
+# section: [donate]
+# Tip: use svg images for better quality (https://www.iconpacks.net)
+donate:
+  title: "Support the Project"
+  description: "If this project helps you, consider supporting it"
+  input:
+    label:
+      key: Chave
+      address: Address
+  copy_button:
+    text: Copy
+    clicked: Copied!
+  services:
+    - name: pix
+      logo: "/assets/images/donate/pix.svg"
+      description: |
+        Faça sua doação usando PIX. Use a chave abaixo.
+      address: "00b53f61-b009-4f05-8c43-444cce86af1d"
+      qrcode: "/assets/images/donate/qrcode_inter.jpg"
+
+    - name: card
+      logo: "/assets/images/donate/card.svg"
+      description: |
+        Donation using card through the service `Buy Me a Coffee`.
+      address: "https://buymeacoffee.com"
+
+    - name: paypal
+      logo: "/assets/images/donate/paypal.svg"
+      description: |
+        Donate quickly and securely using your PayPal balance or linked card.
+      address: "https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=YBK2HEEYG8V5W&source=&ssrt=1775261628264"
+
+    - name: bitcoin (lightning network)
+      logo: "/assets/images/donate/lightning_network.svg"
+      description: |
+        Make an anonymous Bitcoin donation using a Lightning Address.
+      address: "williamcanin@walletofsatoshi.com"
+      qrcode: "/assets/images/donate/qrcode_wos.jpg"
+
+    - name: bitcoin (on-chain)
+      logo: "/assets/images/donate/bitcoin.svg"
+      description: |
+        Make an anonymous Bitcoin donation using a On-Chain address (Binance).
+      address: "bc1qluh2mrchmtrwedspwhtta8ccgzsl9jqdr47f2p"
+      qrcode: "/assets/images/donate/qrcode_btc_binance.jpg"

data/_data/screen/footer.yml

@@ -0,0 +1,17 @@
+# Rawfeed - Footer & Donation Content & Texts
+
+# section: [footer]
+footer:
+  top_button:
+    # Some compatible icons: ↑ ⇡ ▴ 🢙
+    icon: ⇡
+    enable: true
+  copyright:
+    title: "rawfeed-jekyll"
+    since: 2025
+    message:
+  licenses:
+    title: "Licenses"
+    page_url: "/licenses/"
+  message: |
+    Your impactful phrase!

data/_data/screen/head.yml

@@ -0,0 +1,49 @@
+# section: [head]
+# (CSP - Content-Security-Policy)
+# IMPORTANT!!! If you use any external script from any website in your posts that is not on this
+#              list, you must put it here.
+#              --- If you don't use it, don't remove what's already there. ---
+head:
+  csp:
+    frame-src:
+      - https://www.google.com
+      - https://www.youtube.com
+      - https://giscus.app
+      - https://disqus.com
+    connect-src:
+      - https://www.google.com
+      - https://api.github.com
+      - https://script.google.com
+      - https://script.googleusercontent.com
+    img-src:
+      - https://www.google.com
+      - https://media0.giphy.com
+      - https://media4.giphy.com
+      - https://media.giphy.com
+      - https://github.githubassets.com
+    script-src:
+      - https://www.google.com
+      - https://www.gstatic.com
+      - https://script.google.com
+      - https://cdn.jsdelivr.net
+      - https://cdnjs.cloudflare.com
+      - https://giscus.app
+      - https://disqus.com
+    style-src:
+      - https://cdnjs.cloudflare.com
+      - https://fonts.googleapis.com
+      - https://cdn.jsdelivr.net
+      - https://giscus.app
+      - https://disqus.com
+    font-src:
+      - https://fonts.gstatic.com
+      - https://cdnjs.cloudflare.com
+  google:
+    site_verification: ""
+    analytics:
+      enable: false
+      id: "" # tracking id, e.g. "UA-200341029-1"
+    apps_script:
+      url:
+    recaptcha:
+      pubkey:

data/_data/screen/home.yml

@@ -0,0 +1,24 @@
+# Rawfeed - Home Page Content & Texts
+
+# section: [home]
+home:
+  terminal:
+    enable: true
+    user: "rawfeed"
+    hostname: "linux"
+    signal: "#"
+    welcome: " type 'help'"
+    error: ": command not found."
+    no_socials: "No socials found"
+    help:
+      description: |
+        Use the commands below:
+      commands:
+        title: "Commands:"
+        description: "Description:"
+      menu: |
+        about ------------- A brief summary about 'rawfeed'
+        socials ----------- Links to my active social networks
+        clear ------------- Clear the terminal screen (or press Esc)
+        date -------------- Print the system date and time
+        help -------------- Print this menu