Hopiu/lychee
1
0
Fork 0
mirror of https://github.com/Hopiu/lychee.git synced 2026-03-17 05:00:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add troubleshooting guide

Browse source
This commit is contained in:
Matthias 2020-12-01 00:30:28 +01:00 committed by GitHub
parent 958f07ec0e
commit 95751b7b82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
TROUBLESHOOTING.md Normal file
View file

@ -0,0 +1,22 @@
# Toubleshooting Guide
This document describes common edge-cases and workarounds for checking links to various sites.
Please add your own findings and send us a pull request if you can.
## Unexpected Status Codes
Some websites don't respond with a `200` (OK) status code.
Instead they might send `204` (No Content), `206` (Partial Content), or
[something else entirely](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418).
If you run into such issues you can work around that by providing a custom
list of accepted status codes, such as `--accept 200,204,206`.
## Website Expects Custom Headers
Some sites expect one or more custom headers to return a valid response.
For example, crates.io expects a `Accept: text/html` header or else it
will [return a 404](https://github.com/rust-lang/crates.io/issues/788).
To fix that you can pass additional headers like so: `--headers "accept=text/html"`.
You can use that argument multiple times to add more headers.