import configs and display their names with prefixed instance url

Author: gildesmarais

.github/workflows/gh-pages.yml

@@ -32,6 +32,7 @@ jobs:
           bundle config path vendor/bundle
           bundle config --global frozen 1
           bundle install --jobs 4 --retry 3
+          make update
           bundle exec jekyll build
 
       - name: deploy

.gitignore

@@ -4,3 +4,4 @@ _site
 .jekyll-metadata
 vendor
 node_modules/
+_data/configs.yml

.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+
+Style/DoubleNegation:
+  Exclude:
+    - bin/data-update

Gemfile

@@ -4,8 +4,10 @@ source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gem 'jekyll', '~> 4.1.0'
-# This is the default theme for new Jekyll sites. You may change this to anything you like.
-gem 'minima', '~> 2.5'
+gem 'just-the-docs'
+
+gem 'html2rss', git: 'https://github.com/gildesmarais/html2rss.git'
+gem 'html2rss-configs', git: 'https://github.com/gildesmarais/html2rss-configs.git'
 
 group :jekyll_plugins do
   gem 'jekyll-feed', '~> 0.12'

Gemfile.lock

@@ -1,21 +1,57 @@
+GIT
+  remote: https://github.com/gildesmarais/html2rss-configs.git
+  revision: 3419feaab324a559ed00903eccac8d1cc758466c
+  specs:
+    html2rss-configs (0.2.0)
+
+GIT
+  remote: https://github.com/gildesmarais/html2rss.git
+  revision: 5cdc59a82704626fec2c020c36ce7f9bd267ea70
+  specs:
+    html2rss (0.9.0)
+      activesupport (>= 5, < 7)
+      addressable (~> 2.7)
+      builder
+      faraday (~> 1.0)
+      faraday_middleware
+      kramdown
+      mime-types (> 3.0)
+      nokogiri (>= 1.10, < 2.0)
+      reverse_markdown (~> 2.0)
+      sanitize (~> 5.0)
+      to_regexp
+      zeitwerk
+
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    builder (3.2.4)
     colorator (1.1.0)
     concurrent-ruby (1.1.6)
+    crass (1.0.6)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
     ffi (1.13.1)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
     i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    jekyll (4.1.0)
+    jekyll (4.1.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -30,7 +66,7 @@ GEM
       rouge (~> 3.0)
       safe_yaml (~> 1.0)
       terminal-table (~> 1.8)
-    jekyll-feed (0.13.0)
+    jekyll-feed (0.14.0)
       jekyll (>= 3.7, < 5.0)
     jekyll-loading-lazy (0.1.1)
       jekyll (>= 3.0, < 5.0)
@@ -46,6 +82,10 @@ GEM
       nokogiri (~> 1.10)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
+    just-the-docs (0.3.0)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
     kramdown (2.2.1)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -55,55 +95,72 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
     mini_portile2 (2.4.0)
-    minima (2.5.1)
-      jekyll (>= 3.5, < 5.0)
-      jekyll-feed (~> 0.9)
-      jekyll-seo-tag (~> 2.1)
+    minitest (5.14.1)
+    multipart-post (2.1.1)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    nokogumbo (2.0.2)
+      nokogiri (~> 1.8, >= 1.8.4)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.5)
     rainbow (3.0.0)
+    rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (1.7.1)
+    reverse_markdown (2.0.0)
+      nokogiri
     rexml (3.2.4)
     rouge (3.20.0)
-    rubocop (0.85.1)
+    rubocop (0.86.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
+    rubocop-ast (0.1.0)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    sanitize (5.2.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.8.0)
+      nokogumbo (~> 2.0)
     sassc (2.4.0)
       ffi (~> 1.9)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    to_regexp (0.2.1)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  html2rss!
+  html2rss-configs!
   jekyll (~> 4.1.0)
   jekyll-feed (~> 0.12)
   jekyll-loading-lazy
   jekyll-sitemap
   jekyll-target-blank
-  minima (~> 2.5)
+  just-the-docs
   rubocop (~> 0.85)
   tzinfo (~> 1.2)
   tzinfo-data

Makefile

@@ -3,6 +3,7 @@ default: setup clean fix serve
 setup:
 	yarn check || yarn
 	bundle check || bundle
+	make update
 
 fix:
 	prettier --write --no-semi "**/*.yml" "**/*.md" "**/*.scss" "**/*.rb" "assets/**/*.js"  "**/*.mdx"
@@ -13,8 +14,11 @@ clean:
 	find . -type d -empty -delete
 	find . -type f -empty -delete
 
-serve:
-	bundle check || bundle
+update:
+	bundle update html2rss-configs
+	bin/data-update
+
+serve: setup
 	open http://127.0.0.1:4000/
 	bundle exec jekyll s --drafts --trace
 

_config.yml

@@ -8,15 +8,17 @@ permalink: /blog/:year/:title
 
 title: html2rss
 
-twitter_username: ""
-github_username: ""
-
 description: |
-  html2rss brings back RSS. It is an open source project with decentralised
-  instances. These instances provide RSS feeds for websites which do not offer
+  html2rss brings back RSS. It's an open source project with decentralised
+  instances. These instances generate RSS feeds for websites which do not offer
   them.
 
-theme: minima
+github_username: "html2rss"
+
+theme: just-the-docs
+
+header_pages:
+  - configs/index.html
 
 sass:
   style: compressed
@@ -34,9 +36,11 @@ exclude:
   - .gitignore
   - .jekyll-cache/
   - .nvmrc
+  - .rubocop.yml
   - .ruby-version
   - .sass-cache/
   - .stylelintrc.json
+  - bin/
   - Gemfile
   - Gemfile.lock
   - gemfiles/

_includes/head_custom.html

@@ -0,0 +1,7 @@
+<meta name="apple-mobile-web-app-capable" content="yes">
+<meta name="apple-mobile-web-app-status-bar-style" content="black">
+<meta name="referrer" content="no-referrer" />
+<meta
+  name="robots"
+  content="{% if page.noindex %}noindex, noarchive, follow{% else %}index, follow{% endif %}"
+/>

assets/js/configs/index.js

@@ -0,0 +1,36 @@
+;(function() {
+  "use strict"
+
+  const instanceEl = document.querySelector('input[name="instance"]')
+
+  function instanceUrl() {
+    const url = instanceEl.value
+
+    return url.substr(-1) === "/" ? url : `${url}/`
+  }
+
+  function onChangeInstanceUrl() {
+    const url = instanceUrl()
+
+    Array.from(document.querySelectorAll(".instance")).forEach(function(el) {
+      el.innerText = url
+    })
+  }
+
+  function onShowClick(event) {
+    event.target.href = [instanceUrl(), event.target.dataset.path].join("")
+    return false
+  }
+
+  // init
+  document.querySelector("#configs").addEventListener("click", event => {
+    if (event.target.dataset.bindClick === "show") {
+      return onShowClick(event)
+    }
+  })
+
+  instanceEl.addEventListener("keydown", event => {
+    onChangeInstanceUrl()
+  })
+  onChangeInstanceUrl()
+})()

bin/data-update

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'html2rss'
+require 'html2rss/configs'
+require 'yaml'
+
+file_names = Html2rss::Configs.file_names.sort
+
+def valid_url(url)
+  !!URI(url)
+rescue StandardError
+  false
+end
+
+output = file_names.map do |file_name|
+  config = YAML.safe_load(File.open(file_name), symbolize_names: false)
+
+  file_name_splits = file_name.split('/')
+
+  {
+    'domain' => file_name_splits[-2..-2].join,
+    'name' => File.basename(file_name_splits[-1..].join, '.*'),
+    'valid_channel_url' => valid_url(config['channel']['url']),
+    'channel' => config['channel']
+  }
+end
+
+config_file = File.join(__dir__, '..', '_data/configs.yml')
+File.write(config_file, output.to_yaml)