You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In #1576, we added support for the --root-dir parameter.
It is useful for checking absolute links, especially when the rendered documents are located in a subdirectory.
Common usage scenarios for --root-dir
Static site builds in a public or dist directory
Documentation sites with absolute links
Any project where links start with /
Here's a usage example
# Assuming the output html files get rendered into the `public` directory
lychee --root-dir "$(pwd)/public""**/*.html"
Add support for relative paths, e.g. . or ./public.
That would be very convenient and relatively easy to implement.
We could apply std::fs::canonicalize when we handle the root-dir:
use std::fs::canonicalize;use std::path::PathBuf;fnmain(){let path = PathBuf::from(".");println!("{:?}", canonicalize(path));}
Our argumentation for not doing that in the first place was that we wanted to be conservative and avoid running into edge-cases. However, after playing with the feature a bit, I'm beginning to think there is no downside to supporting that.
The above example would be simplified to
lychee --root-dir public "**/*.html"
FYI @trask, since you worked on the initial implementation.
Edit: Removed my other proposal of making --root-dir . the default. I'm no longer confident that this is a good idea.
The text was updated successfully, but these errors were encountered:
In #1576, we added support for the
--root-dir
parameter.It is useful for checking absolute links, especially when the rendered documents are located in a subdirectory.
Common usage scenarios for
--root-dir
/
Here's a usage example
Full documentation here.
Proposal
Add support for relative paths, e.g.
.
or./public
.That would be very convenient and relatively easy to implement.
We could apply
std::fs::canonicalize
when we handle theroot-dir
:Our argumentation for not doing that in the first place was that we wanted to be conservative and avoid running into edge-cases. However, after playing with the feature a bit, I'm beginning to think there is no downside to supporting that.
The above example would be simplified to
lychee --root-dir public "**/*.html"
FYI @trask, since you worked on the initial implementation.
Edit: Removed my other proposal of making
--root-dir .
the default. I'm no longer confident that this is a good idea.The text was updated successfully, but these errors were encountered: