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

Make mdBook and mdBook-linkcheck format match in README #248

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Make mdBook and mdBook-linkcheck format match in README #248

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db1b2d5
make mdBook and mdBook-linkcheck format match
itscynxx Oct 25, 2023
497623b
Merge branch 'main' into update-readme
GeckoEidechse Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ To install mdBook use the following link if:
- [you **DON'T** have Rust toolchain installed](https://rust-lang.github.io/mdBook/guide/installation.html#pre-compiled-binaries)

#### mdBook-linkcheck
Additionally there's a community-made package that you can use alongside mdBook to show you some potentially broken links in markdown files called [mdBook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck)
Additionally there's a community-made package that you can use alongside mdBook to show you some potentially broken links in markdown files called [`mdBook-linkcheck`](https://github.com/Michael-F-Bryan/mdbook-linkcheck)

Although not required, you may find it helpful to use alongside mdBook to ensure you've linked things properly

To install mdBook-linkcheck use the following link if:
- [you have Rust toolchain installed](https://github.com/Michael-F-Bryan/mdbook-linkcheck#getting-started)
- [you DON'T have Rust toolchain installed](https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest) (add `mdBook-linkcheck.exe` to the same folder `mdBook.exe` is located)
- [you **DON'T** have Rust toolchain installed](https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest) (add `mdBook-linkcheck.exe` to the same folder `mdBook.exe` is located)