Question 1

How do I ignore certain URLs when using deadlink?

Accepted Answer

Add hosts to the 'ignore_hosts' list in the deadlink.toml config file, e.g., ['www.example.com'], to skip checking URLs from those domains. This is useful for excluding internal or temporary sites.

Question 2

Deadlink vs lychee: which should I use for link checking?

Accepted Answer

Deadlink is a Python tool focused on configurability and caching for text files, ideal for Python-centric workflows. Lychee is a Rust-based alternative with potentially faster performance and broader file support; choose Deadlink for its TOML configurability, lychee for speed and cross-language compatibility.

Question 3

Can deadlink check links in binary files like PDFs?

Accepted Answer

No, deadlink only parses text files with allowed extensions (default includes txt, yaml, c). It does not support binary formats, so you'll need pre-processing to extract text first.

Question 4

How to set up deadlink in a CI/CD pipeline?

Accepted Answer

Install deadlink via pip in your pipeline script, then run 'deadlink check' on target directories. Configure timeouts and ignore hosts in deadlink.toml to handle network issues and exclude irrelevant domains.

Question 5

Does deadlink handle HTTP redirects properly?

Accepted Answer

Yes, deadlink follows HTTP redirects and reports the final status code. You can adjust the timeout_s in config to manage slow or infinite redirects during checks.

Question 6

What file extensions does deadlink support by default?

Accepted Answer

Deadlink checks common text-based extensions like .txt, .md, and .yaml, but you can customize this via the 'allow_file_extensions' setting in the config file to include or exclude specific types.

Question 7

How to cache results with deadlink to speed up repeated runs?

Accepted Answer

Deadlink automatically caches URL results based on the cache_ttl_s setting in the config file. Set a TTL (e.g., 259200 seconds for 3 days) to balance freshness and performance, avoiding redundant network requests.

deadlink

What is deadlink?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions