jekyll-external-links 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5491051e0ca68c8d51fb38d75253c02840b2c48034c0ab32ad2a23458968ad2
-  data.tar.gz: 262dbe240bd7aa8a2dbfa213d97120da987668edf5a7f29378c3f4eb77345930
+  metadata.gz: 4efb8b28bc048b183d977ab09009166623eea525df19880e2db33644fe912e82
+  data.tar.gz: 6d34b1008c0b3388dc9853d97cdfddcbaa47915f1f14957c120b887cd8748e2c
 SHA512:
-  metadata.gz: 81f80e33df4b5de6bdc49811aa4069b88ef493994518d62fd172cebabc645ee667074098030111d87cbfa9c32b8a1204a33b515671c53790cd89f0be0fb75f2d
-  data.tar.gz: d59e34609425a96b7331e1411901f602c83cb2033007ceaa6ac5d19f0fd56ae90082dc1d19b3582e740c0fa416f5cfed5649636cac6d9c14dc7b317ea6c34470
+  metadata.gz: c0d6c8cc12e7c60bae9662fc0e2aced14b88177db0995a23853e914d2c175a849e4d444f2d2accaa3355f7f07179e6c202b944d688375e28b8d2278fa498ed76
+  data.tar.gz: 0e3dc41fa245e54b6487644e32791508bffbf064b2631d5d104e988e0f158cf5c33184b98959b4999effd6ade73caa8d1811ae10e0ceb50906a4a6e3432e1faa

data/.gitignore

@@ -1 +1,2 @@
 example-site/_site
+example-site/vendor

data/README.md

@@ -1,15 +1,29 @@
 # Jekyll plugin that marks external links
 
-In each Jekyll document or page content, updates `<a>` elements that point
-to external sites as follows:
+In rendered HTML contents of each Jekyll document or page,
+updates `<a>` elements that point to external sites as follows:
 
 - Adds `rel="external"` attribute
 - Adds inner HTML markup with external link icon
 
-You can specify a CSS selector for which links are to be marked,
+You can specify a CSS selector for which links are to be evaluated,
 and a list of selectors for which links are to be ignored
 (ignored selectors take precedence).
 
+## Which links are considered external
+
+A link is considered external if:
+
+* Its `href` attribute value starts with “http” or “https”, and
+* the domain name following “http(s)://” is not equal to the
+  domain name part from site’s URL,
+  if such is specified in Jekyll configuration as `url`.
+
+## Compatibility and dependency notes
+
+* Tested with Jekyll 4.3.2; see example site’s gem lockfile for further details.
+* Depends on Nokogiri for detecting and marking external links.
+
 ## Configuration
 
 Example configuration with defaults:
@@ -24,12 +38,44 @@ external_links:
   marker_html: "<span class='ico-ext'><i class='fas fa-external-link-square-alt'></i></span>"
 ```
 
-As you can see, by default the Font Awesome’s `fa-external-link-square-alt` icon is used,
-which implies that you are using Font Awesome.
+Note the assumptions made by the defaults:
+
+* Links you want to be marked as external are always within the `<main>` tag.
+
+* You use Font Awesome in your site.
+
+* Links containing “travis”, “coverity” and “codecov”
+  are only used in badges, and you don’t want to process those.
+
+If some of these assumptions don’t apply to your site,
+you can add that structure to your `_config.yml` and customize the values.
+
+### `external_links.selector`
+
+Only links matching this CSS path will be processed.
+
+### `external_links.marker_html`
 
-You can set marker_html to empty string and style links with custom CSS rule
+The specified HTML markup will be added inside each `<a>` tag
+that’s detected as external link.
+
+By default, the Font Awesome’s `fa-external-link-square-alt` icon is used,
+which requires your site to have Font Awesome initialized.
+
+You can set `marker_html` to empty string and style links with a custom CSS rule
 (e.g., `a[rel=external] { border-bottom-style: dashed; }`), though it’s less flexible.
 
+### `external_links.ignored_selectors`
+
+Even if a link matches `selector`, it won’t be altered if it also matches any of these
+selectors.
+
+### `url`
+
+The `url` option in your Jekyll configuration is used when deciding
+whether a given link is external or not. If not specified,
+only domain-relative links are considered internal.
+
 ## Example site
 
 An example site is included in this repo.
@@ -37,7 +83,22 @@ Use it to demo the plugin and to test it during development.
 The `/` path leads to Markdown version, the `/asciidoc/` path leads to AsciiDoc version.
 
 1. Clone this repository
-2. Navigate into the example-project directory
+2. Navigate into the example-site directory
 3. Run `bundle`
 4. Run `bundle exec jekyll serve`
 5. Open in your favorite browser the URL shown
+
+Note that, due to the fact that gem lockfiles are platform-specific,
+it may not work out of the box.
+
+The example site build may output deprecation warnings
+coming from the default Minima theme
+not being fully compatible with the latest Jekyll/SASS stack.
+
+## Contribution
+
+Contributions are welcome.
+
+It’s appreciated if you also update the bundled example site to illustrate
+the changes in your PR. The example site adds the plugin via a relative path,
+and any changes you make to plugin code will take effect on next rebuild.

data/jekyll-external-links.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'jekyll-external-links'
-  s.version       = '1.0.0'
+  s.version       = '1.0.2'
   s.authors       = ['Ribose Inc.']
   s.email         = ['open.source@ribose.com']
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(example-site|test|spec|features)/!) }
 
   s.add_runtime_dependency 'jekyll', '~> 4.0'
-  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'nokogiri', '~> 1.0'
   s.add_development_dependency 'rake', '~> 12.0'
   s.add_development_dependency 'rubocop', '~> 0.50'
 

data/lib/jekyll-external-links/external_links.rb

@@ -42,8 +42,11 @@ def mark_links_in_page_or_document(page_or_document)
     'a[href*=coverity]',
     'a[href*=codecov]',
   ]
-
-  unless page_or_document.respond_to?(:asset_file?) and page_or_document.asset_file?
+  
+  # Do not process assets or other non-HTML files
+  unless (page_or_document.respond_to?(:asset_file?) and
+      page_or_document.asset_file?) or
+      page_or_document.output_ext != ".html"
     page_or_document.output = process_content(
       site_hostname,
       page_or_document.output,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-external-links
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.50'
-description: 
+description:
 email:
 - open.source@ribose.com
 executables: []
@@ -84,7 +84,7 @@ homepage: https://github.com/riboseinc/jekyll-external-links/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Jekyll plugin that marks external links in your site
 test_files: []