Skip to content

Commit

Permalink
Mention supported schemes
Browse files Browse the repository at this point in the history
  • Loading branch information
mre committed Sep 14, 2023
1 parent 3d9fb29 commit 5787374
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
12 changes: 12 additions & 0 deletions usage/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ ARGS:
> Most of the options (like `--scheme` or `--exclude`) are for **links inside inputs**,
> and **not** for the filtering the inputs themselves.
## On Schemes

lychee supports the following schemes:

* `http`
* `https`
* `file`
* `mailto`

If you don't specify any schemes, lychee will check all links regardless of
their scheme. Otherwise, it will only check links with the specified schemes.

## Repeating Options

Options marked with `...` can be specified multiple times.
Expand Down
7 changes: 4 additions & 3 deletions usage/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ timeout = 30

## Default Location of the Configuration File

`./lychee.toml` (in the current working directory) is used if no other configuration file is specified.
`./lychee.toml` (in the current working directory) is used if no other configuration file is specified.
Here is an example of a configuration file.
Please find the [latest version on Github](https://github.com/lycheeverse/lychee/blob/master/lychee.example.toml).

Expand Down Expand Up @@ -77,7 +77,8 @@ accept = [200, 429]
insecure = false

# Only test links with the given schemes (e.g. https).
# Omit to check links with any scheme.
# Omit to check links with any other scheme.
# At the moment, we support http, https, file, and mailto.
scheme = [ "https" ]

# When links are available using HTTPS, treat HTTP links as errors.
Expand All @@ -91,7 +92,7 @@ headers = []

# Remap URI matching pattern to different URI.
# This also supports (named) capturing groups.
remap = [
remap = [
"https://example.com http://example.invalid",
"https://example.com/(.*) http://example.org/$1",
"https://github.com/(?P<org>.*)/(?P<repo>.*) https://gitlab.com/$org/$repo",
Expand Down

0 comments on commit 5787374

Please sign in to comment.