README.md in jekyll-external-links-1.0.1 vs README.md in jekyll-external-links-1.0.2
- old
+ new
@@ -13,14 +13,19 @@
## 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 your site URL
- (which you have to specify as `url` in Jekyll configuration).
+* 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:
```
@@ -65,19 +70,35 @@
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 configuration file is used when deciding
-whether a given link is external or not.
+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.
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.