jekyll-mastodon_webfinger 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1535439f0568c21208d168937f0729e1cec174361ebe24ce8c554d7bf15d80a
-  data.tar.gz: 78e1b7f75e0f0cbbe9fb33d7b0995616608d8e8b7bc42d0848492779261419d1
+  metadata.gz: d3f3b608f5643a67e02ab6336206266460762f38e7566c20e318b7294b91101c
+  data.tar.gz: 8653030fe52bebd9510261afab328feeb1d2e4bdaa62d4047358481bfc86e166
 SHA512:
-  metadata.gz: 816ee6cd3ff548fd4758e2225fed8dcc443ab3ffaca62ad02886112f8ea46f29f58abd0fadfe9092a6d7791cf753fbcbbaa806ce20bb4084b095380cd815cfd4
-  data.tar.gz: 9b4c3681b7cd3585e32b3675a9f4efad831c4266b266c6be169af3b4b619e2f1dd6f486a57a121c96676086e4bd77c1d8412f6c653a8eccaecfa0ab558a7fbd6
+  metadata.gz: 90b6eabf062e040d7d0b9c6ee865fb7e64f8f3c1394171e69f968a679dec1aa0fc9fb671ac50463a07b96027b57183d4e2e6acbc6dd384880c58f0befcea78b9
+  data.tar.gz: e55ed3596acb13b15cfb8e03bc0dcc6e8f9ae30f16b654006cc916b97a126866ed128dfa33bc52e6ff2fe3729243139101cf98b195dc0d1696ee061f485b98e5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.0.2] - 2022-11-25
+
+- Updates hook to use `site.keep_files` instead of `site.config["keep_files"]`
+
+## [1.0.1] - 2022-11-20
+
+- Adds hook that includes `.well-known/webfinger` in the `keep_files` config
+
 ## [1.0.0] - 2022-11-19
 
 - Initial release

data/README.md

@@ -1,9 +1,17 @@
 # `Jekyll::MastodonWebfinger`
 
-This is a [Jekyll](https://jekyllrb.com/) plugin that adds a [WebFinger](https://webfinger.net/) file to your site, allowing you to use your own domain to help others discover your [Mastodon](https://joinmastodon.org/) profile.
+<h2>Use your Jekyll website domain as an alias for your Mastodon username</h2>
+
+This is a [Jekyll](https://jekyllrb.com/) plugin that adds a [WebFinger](https://webfinger.net/) file to your site, allowing you to use your own domain as an alias to help others discover your [Mastodon](https://joinmastodon.org/) profile.
+
+<h3>Try it out</h3>
+
+Search Mastodon for `@phil@philna.sh` and you will find my Mastodon profile.
 
 * [What?](#what)
+  * [Alternatives](#alternatives)
 * [How to use](#how-to-use)
+  * [Config](#config)
   * [Drawbacks](#drawbacks)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -12,15 +20,20 @@ This is a [Jekyll](https://jekyllrb.com/) plugin that adds a [WebFinger](https:/
 
 ## What?
 
-You may be tempated to run your own Mastodon instance so that you can use your own domain. But that's probably hard work.
+You may be tempted to run your own Mastodon instance so that you can use your own domain. If you don't want the work of managing a server you can instead use your domain as an alias to point to your Mastodon profile.
 
-Instead, you can use your domain to point to your profile on a Mastodon instance that you are signed up to. This uses [WebFinger](https://webfinger.net/), which is a way to attach information to an email address or other online resource. In this case you can point email addresses on your own domain to your Mastodon profile.
+This uses [WebFinger](https://webfinger.net/), which is a way to attach information to an email address or other online resource. In this case you can point email addresses on your own domain to your Mastodon profile.
 
-For example, I have a Mastodon profile at [@philnash@mastodon.social](https://mastodon.social/@philnash). If I add this plugin to my Jekyll site at https://philna.sh and set the username to `philnash` and the instance to `mastodon.social`, then you will be able to find my account by searching for "phil@philna.sh" in any Mastodon instance.
+For example, I have a Mastodon profile at [@philnash@mastodon.social](https://mastodon.social/@philnash). If I add this plugin to my Jekyll site at https://philna.sh and set the username to `philnash` and the instance to `mastodon.social`, then you will be able to find my account by searching for `phil@philna.sh` in any Mastodon instance.
 
 For a more in depth explanation, check out [Mastodon on your own domain without hosting a server
 by Maarten Balliauw](https://blog.maartenballiauw.be/post/2022/11/05/mastodon-own-donain-without-hosting-server.html).
 
+### Alternatives
+
+* @dkundel's [netlify-plugin-mastodon-alias](https://github.com/dkundel/netlify-plugin-mastodon-alias)
+* Lindsay Kwardell explains [how to integrate Mastodon with Astro](https://www.lindsaykwardell.com/blog/integrate-mastodon-with-astro)
+
 ## How to use
 
 Add the gem to your Jekyll site's `Gemfile` by executing:
@@ -33,20 +46,24 @@ Or by opening the `Gemfile`, adding:
 
 and then running `bundle install`.
 
-Then in your Jekyll site's `_config.yml` file add your Mastodon account details. For example:
+### Config
+
+You need to add two things to your `_config.yml` file.
+
+1. Add your Mastodon account details. For example:
 
-```yml
-mastodon:
-  username: philnash
-  instance: mastodon.social
-```
+   ```yml
+   mastodon:
+     username: philnash
+     instance: mastodon.social
+   ```
 
-Also, add `jekyll/mastodon_webfinger` to the `plugins` list in `_config.yml`:
+2. Add `jekyll/mastodon_webfinger` to the `plugins` list:
 
-```yml
-plugins:
-  - jekyll/mastodon_webfinger
-```
+   ```yml
+     plugins:
+       - jekyll/mastodon_webfinger
+   ```
 
 Next time you build your Jekyll site, you will find a `/.well-known/` directory in the output with a `webfinger` file that contains the required JSON.
 
@@ -58,7 +75,7 @@ Since this generates a static file, this actually acts like a catch-all email ad
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.**** To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/jekyll/mastodon_webfinger/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module MastodonWebfinger
-    VERSION = "1.0.0"
+    VERSION = "1.0.2"
   end
 end

data/lib/jekyll/mastodon_webfinger.rb

@@ -4,3 +4,8 @@ require "json"
 require "jekyll"
 require_relative "mastodon_webfinger/version"
 require_relative "mastodon_webfinger/generator"
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  keep_files = site.keep_files || []
+  site.keep_files = keep_files.push(".well-known/webfinger").uniq
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-mastodon_webfinger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Phil Nash
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll