Skip to content

Commit

Permalink
How to whitelist urls
Browse files Browse the repository at this point in the history
  • Loading branch information
sharktrexer authored Jan 14, 2025
1 parent 01e4d06 commit fcb2071
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,20 @@ This will keep the integrity of your document and create new files like

If you like the changes Link Reaper made, rename reaped-example.md to example.md to overwrite the original document with a cleaner link list. Feel free to delete the afterlife & log files.

#### Whitelisting URLs

If there are certain urls or web domains you'd rather this program ignore, utilize the `--ignore_urls` option. For example, if you want to ignore a specific url, do:

`python link-reaper reap example.md -iu https://github.com/sharktrexer/link-reaper`

But, lets say you want to ignore ALL github urls, then simply do:

`python link-reaper reap example.md -iu github.com`

Or, if you wanted to ignore all of a certain path from github, you could do:

`python link-reaper reap example.md -iu github.com/sharktrexer`

### GitHub Workflow

Link Reaper can be used to verify pushes and pull requests using workflows, without changing any aspect of a document. See below for an example that verifies links without any extra fluff or potential to overwrite changes.
Expand Down

0 comments on commit fcb2071

Please sign in to comment.