Skip to content

Commit 3088aa1

Browse files
committed
Minor README.md update
1 parent d65fdd5 commit 3088aa1

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,11 @@ this hook only proceed to do so once, the first time an article is published.
5959

6060
In order to do so, it uses a very simple and small cache that contains the list of all hyperlinks already parsed, per article `slug`.
6161

62-
To remove a blog entry from cache, in order for the plugin to retry sending a linkback:
62+
To list successful linkbacks, using [`jq`](https://jqlang.org/):
63+
64+
jq -r . pelican-plugin-linkbacks.json | grep -B5 '"response"'
65+
66+
To remove a blog entry from cache, in order for the plugin to retry sending a linkback, using [`jq`](https://jqlang.org/):
6367

6468
jq "del(.['$slug'])" pelican-plugin-linkbacks.json | sponge pelican-plugin-linkbacks.json
6569

@@ -76,6 +80,8 @@ where `$CACHE_PATH` is [a Pelican setting](https://docs.getpelican.com/en/latest
7680
enforce HTTPS certificates verification when sending linkbacks
7781
- `LINKBACKS_REQUEST_TIMEOUT` (optional, in seconds, default: `3`) :
7882
time in seconds allowed for each HTTP linkback request before abandon
83+
- `LINKBACKS_IGNORED_URLS_PATTERN` (optional, default to: `artstation.com|deviantart.com|github.com|github.io|itch.io|readthedocs.io|youtube.com|wikipedia.org`) :
84+
list of hostnames to NOT try to send linkbacks to
7985

8086

8187
## Manual execution
@@ -84,7 +90,7 @@ The `linkbacks.py` module can be used as script to test this plugin behavior:
8490
export SITEURL=...
8591
python path/to/pelican/plugins/linkbacks/linkbacks.py $pelican_generated_html_file
8692

87-
To test sending a notification for a given URL to an endpoint, you can use the `cli_notifier.py` script.
93+
To test sending a notification for a given URL to an endpoint, you can use the [`cli_notifier.py`](./cli_notifier.py) script.
8894

8995

9096
## Contributing

0 commit comments

Comments
 (0)