feat: add syndicator-indienews package - #880
aciccarello wants to merge 17 commits into
Conversation
|
Alright, I tested this locally and confirmed it worked. I just needed to make sure the format file passed the syndication property through. That works for my setup but I'm leaving this PR in draft since there's a few key questions that this depends on:
I would say yes to all 3 (including reworking the plugin to be more general) but wanted to wait for feedback before I made additional changes. |
syndicator-indienews package
67b3847 to
fa1d368
Compare
|
I maintain an IndieNews syndicator too, so for what it's worth: I think yours is the better default, and I'd rather back it than argue for mine. Mine implements Two things from mine that might be worth folding in, both small:
Neither is a blocker on this PR. |
|
I'm glad you think the structure is good. As far as the language name I think that's a good option. I assume the Intl API has something for that. I also might not show the language if only one is set up to simplify it in a visual list. I'll admit I don't have a good way to test the webmention sender as my server does not have a database configured nor do I have a hook set up to indicate when the build is complete. I'd appreciate some help with that portion. |
|
I'm going to setup a test environment so I can test this properly, will let you know when I have some results |
|
One thing I noticed while looking at the code is that the syndication endpoint checks if a syndication value already exists in the post properties as a check for if the post was already syndicated. Because of that |
|
If the already syndicated check is not a blocker, I do like to modify the indie news URLs after the fact to point to the permalink (including the post URL). It'd be nice to include that in the plugin. That can only be done after the webmention has been sent so it can't be part of the original URL creation. |
|
Confirmed, and it's a catch-22 unique to IndieNews. IndieNews requires the post to link to Publishing it as So: not a blocker if the required link is a On rewriting the IndieNews URL to the permalink after the webmention: agreed that's the more useful value, and it can only happen post-submission. |
Extends #882
Closes #860
Summary
Adds an indienews syndicator for webmention based syndication.
Note
This plugin writes the IndieNews URL into the
syndicationproperty of the post file. For IndieNews to actually discover the post, the post template must exposeu-syndicationin the HTML markup, and the site must send a Webmention to the IndieNews channel URL after publishing.Changes
syndicator-indienews(new package)@indiekit/syndicator-indienewspackage for IndieNews.getSyndicationUrl(), returning the IndieNews channel URL.syndicate()method — IndieNews syndication is webmention-based; this plugin handles the file-write step only.Interface
Configuration example
{ "plugins": ["@indiekit/syndicator-indienews"], "@indiekit/syndicator-indienews": { "language": "en" } }Multiple languages:
{ "@indiekit/syndicator-indienews": [ { "language": "en" }, { "language": "es" } ] }