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

Update troubleshooting guide, add .editorconfig (#60)

Browse source
This commit is contained in:
Paweł Romanowski 2020-12-02 23:07:52 +01:00 committed by GitHub
parent 942de7d6ab
commit e197012e7a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 36 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
.editorconfig Normal file
View file

@ -0,0 +1,19 @@
root = true
[*]
end_of_line = lf
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
[*.rs]
indent_size = 4
[*.html]
indent_size = 2
[*.yml]
indent_size = 2
[Makefile]
indent_style = tab

4
README.md
View file

@ -2,7 +2,7 @@
![Rust](https://github.com/hello-rust/lychee/workflows/Rust/badge.svg)
A fast, async, resource-friendly link checker written in Rust.
A fast, async, resource-friendly link checker written in Rust. \
For GitHub links, it can optionally use a `GITHUB_TOKEN` to avoid getting blocked by the rate
limiter.
@ -65,7 +65,7 @@ This comparison is made on a best-effort basis. Please create a PR to fix outdat
## Contributing to lychee
We'd be thankful for any contribution.
We'd be thankful for any contribution. \
We try keep the issue-tracker up-to-date so you can quickly find a task to work on.
Try one of these links to get started:

26
TROUBLESHOOTING.md
View file

@ -1,22 +1,26 @@
# Toubleshooting Guide
# Troubleshooting 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.
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
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
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).
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.
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. \
Or, you can accept all content/MIME types: `--headers "accept=*/*"`.
See more info about the Accept header
[over at MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept).