@benjifs/wm
v1.6.0
Published
Fork of @remy/webmention
Maintainers
Readme
Fork of webmention.app
This forked version of webmention.app. It is deployed to Netlify and uses a function to receive requests.
Changes
- Add Netlify functions support (check.js)
- Add support for parsing links in
h-entrybut outsidee-content(4d856e5). PR #31. - Remove
limitingetEndpoints(58c9312). Issue #66.
Usage
To check for webmentions:
GET https://webmention.netlify.app/check?url=:url
To send webmentions:
POST https://webmention.netlify.app/check?url=:url
You can also install this fork for your project with:
npm install @benjifs/wmEverything below is from the original README for the project.
Automate your outgoing webmentions
webmention.app is a platform agnostic service that will check a given URL for links to other sites, discover if they support webmentions, then send a webmention to the target.
This repository also includes a stand alone command line tool that doesn't rely on webmention.app at all and doesn't require a token - so you can run it locally with the knowledge that if your site outlives this one, the tool will still work.
Installation
The tool uses nodejs and once nodejs is installed, you can install the tool using:
$ npm install @remy/webmentionThis provides an executable under the command webmention (also available as wm). Default usage allows you to pass a filename (like a newly generated RSS feed) or a specific URL. It will default to the 10 most recent entries found (using item for RSS and h-entry for HTML).
Usage
By default, the command will perform a dry-run/discovery only. To complete the notification of webmentions use the --send flag.
The options available are:
--send(default: false) send the webmention to all valid endpoints--limit n(default: 10) limit to n entries found--debug(default: false) print internal debugging Using npx you can invoke the tool to read the latest entry in your RSS feed:
$ npx webmention https://yoursite.com/feed.xml --limit 1 --sendAlternatively, you can make the tool part of your build workflow and have it execute during a postbuild phase:
{
"scripts": {
"postbuild": "webmention dist/feed.xml --limit 1 --send"
}
}Misc
- Further documentation found on webmention.app/docs
- Built by @rem
- MIT / rem.mit-license.org
