Fix Links & Add Link Checker (#2769)

* feat: link checker

Author: DogeDark

.github/workflows/main.yml

@@ -159,6 +159,25 @@ jobs:
           # todo: re-enable warnings
           # RUSTDOCFLAGS: --cfg docsrs -Dwarnings
 
+  # Check for invalid links in the repository
+  link-check:
+    if: github.event.pull_request.draft == false
+    name: Check For Invalid Links
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Restore lychee cache
+        uses: actions/cache@v3
+        with:
+          path: .lycheecache
+          key: cache-lychee-${{ github.sha }}
+          restore-keys: cache-lychee-
+      - name: Run lychee
+        uses: lycheeverse/lychee-action@v1
+        with:
+          args: --base . --config ./lychee.toml './**/*.md'
+          fail: true
+
   check:
     if: github.event.pull_request.draft == false
     name: Check

lychee.toml

@@ -0,0 +1,6 @@
+# This is the configuration file for lychee, a link validator.
+exclude = ['file:///', 'https://github.com/DioxusLabs/dioxus/commit']
+exclude_path = ['target']
+no_progress = false
+cache = true
+max_cache_age = "10d"

packages/autofmt/README.md

@@ -8,7 +8,7 @@
 [crates-badge]: https://img.shields.io/crates/v/dioxus-autofmt.svg
 [crates-url]: https://crates.io/crates/dioxus-autofmt
 [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
-[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
+[mit-url]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 [actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
 [actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
 [discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
@@ -36,7 +36,7 @@ This is done manually with a via set of formatting rules. The output is not guar
 
 This project is licensed under the [MIT license].
 
-[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
+[mit license]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in Dioxus by you shall be licensed as MIT without any additional

packages/check/README.md

@@ -8,7 +8,7 @@
 [crates-badge]: https://img.shields.io/crates/v/dioxus-autofmt.svg
 [crates-url]: https://crates.io/crates/dioxus-check
 [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
-[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
+[mit-url]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 [actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
 [actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
 [discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
@@ -32,7 +32,7 @@
 
 This project is licensed under the [MIT license].
 
-[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
+[mit license]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in Dioxus by you shall be licensed as MIT without any additional

packages/config-macro/README.md

@@ -8,15 +8,15 @@
 [crates-badge]: https://img.shields.io/crates/v/dioxus-config-macro.svg
 [crates-url]: https://crates.io/crates/dioxus-config-macro
 [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
-[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
+[mit-url]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 [actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
 [actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
 [discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
 [discord-url]: https://discord.gg/XgGxMSkvUM
 
 [Website](https://dioxuslabs.com) |
 [Guides](https://dioxuslabs.com/learn/0.5) |
-[API Docs](https://docs.rs/dioxus-config-macro/latest/dioxus_core_macro) |
+[API Docs](https://docs.rs/dioxus-config-macro/latest/dioxus_config_macro/) |
 [Chat](https://discord.gg/XgGxMSkvUM)
 
 ## Overview
@@ -32,7 +32,7 @@
 
 This project is licensed under the [MIT license].
 
-[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
+[mit license]: https://github.com/dioxuslabs/dioxus/blob/main/LICENSE-MIT
 
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in Dioxus by you shall be licensed as MIT without any additional