Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch Link Checker to Lychee (Rust) #715

Open
Arteiii opened this issue Dec 16, 2024 · 0 comments · May be fixed by #717
Open

Switch Link Checker to Lychee (Rust) #715

Arteiii opened this issue Dec 16, 2024 · 0 comments · May be fixed by #717

Comments

@Arteiii
Copy link
Contributor

Arteiii commented Dec 16, 2024

The current link-checker used in the project, installed via Pip, throws errors when running the command:
link-checker ./book

Lychee would be a Rust alternative that can be installed via cargo and doesn't require contributors to download unnecessary Python dependencies

Lychee:

  • Easy to install via cargo install lychee
  • Supports recursive checking of HTML and Markdown

Example:
lychee ./book
or to prevent ratelimits
lychee ./book --retry-wait-time 20 --max-retries 3
Arteiii added a commit to Arteiii/rust-cookbook that referenced this issue Dec 16, 2024
@Arteiii
xtask without worksapce fix rust-lang-nursery#715, fix rust-lang-nurs…
35e3d71 
…ery#712 (maybe?)

- reworked book operations in xtask
- updated readme for new build command
- updated contribution.md for new test commands
- fixed missing dictionary
- added contributor tests to xtask (`cargo test`, `mdbook serve -o`, `./ci/spellcheck.sh`, `link-checker ./book` (moved to Lychee))
- updated ci .sh files for the new cookbook dir
- fixed broken link
@Arteiii Arteiii linked a pull request Dec 16, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

added xtask bin for tests (#715, #712) Arteiii/rust-cookbook
1 participant
@Arteiii