[Merged by Bors] - GitHub Action: Check local Markdown links on push

.github/bors.toml

@@ -7,6 +7,7 @@ status = [
  "build-wasm (nightly, ubuntu-latest)",
  "build-android",
  "markdownlint",
+ "check-markdown-links",
  "run-examples",
  "check-doc",
 ]

.github/linters/markdown-link-check.json

@@ -0,0 +1,21 @@
+{
+ "ignorePatterns": [
+ {
+ "pattern": "^https?://github\\.com/"
+ }
+ ],
+ "replacementPatterns": [],
+ "httpHeaders": [
+ {
+ "urls": ["https://crates.io"],
+ "headers": {
+ "Accept": "text/html"
+ }
+ }
+ ],
+ "timeout": "20s",
+ "retryOn429": true,
+ "retryCount": 5,
+ "fallbackRetryDelay": "30s",
+ "aliveStatusCodes": [200, 206]
+}

.github/workflows/ci.yml

@@ -93,6 +93,16 @@ jobs:
  # Not needed here as only one Linter is used.
  #GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+ check-markdown-links:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: gaurav-nelson/github-action-markdown-link-check@0fe4911067fa322422f325b002d2038ba5602170
+ with:
+ use-quiet-mode: 'yes'
+ use-verbose-mode: 'yes'
+ config-file: '.github/linters/markdown-link-check.json'
+
  run-examples:
  runs-on: ubuntu-latest
 

docs/linters.md

@@ -28,13 +28,13 @@ Explanation:
 ### [markdownlint](https:/DavidAnson/markdownlint)
 
 `markdownlint` is provided by `super-linter` and is responsible for `.md` files.
-Its configuration is saved in the [.markdown-lint.yml](../.github/linters/markdown-lint.yml) file.
+Its configuration is saved in the [.markdown-lint.yml](../.github/linters/.markdown-lint.yml) file.
 
 The provided rules are documented [here](https:/DavidAnson/markdownlint/blob/main/doc/Rules.md) and information about setting the config can be seen [here](https:/DavidAnson/markdownlint#optionsconfig).
 
 #### Using [VS Code markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
 
-If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below.
+If you want to use the VS Code Extension with the rules defined in [.markdown-lint.yml](../.github/linters/.markdown-lint.yml), then you need to create a local config file in the root of the project with the configuration below.
 Currently, this is not needed as the extension already disables the rule `MD013` by default.
 
 ```json

examples/README.md

@@ -99,7 +99,7 @@ Example | File | Description
 `msaa` | [`3d/msaa.rs`](./3d/msaa.rs) | Configures MSAA (Multi-Sample Anti-Aliasing) for smoother edges
 `orthographic` | [`3d/orthographic.rs`](./3d/orthographic.rs) | Shows how to create a 3D orthographic view (for isometric-look games or CAD applications)
 `parenting` | [`3d/parenting.rs`](./3d/parenting.rs) | Demonstrates parent->child relationships and relative transformations
-`pbr` | [`3d/pbr.rs`](./3d/[pbr].rs) | Demonstrates use of Physically Based Rendering (PBR) properties
+`pbr` | [`3d/pbr.rs`](./3d/pbr.rs) | Demonstrates use of Physically Based Rendering (PBR) properties
 `render_to_texture` | [`3d/render_to_texture.rs`](./3d/render_to_texture.rs) | Shows how to render to texture
 `spawner` | [`3d/spawner.rs`](./3d/spawner.rs) | Renders a large number of cubes with changing position and material
 `texture` | [`3d/texture.rs`](./3d/texture.rs) | Shows configuration of texture materials
@@ -183,7 +183,7 @@ Example | File | Description
 `mouse_input` | [`input/mouse_input.rs`](./input/mouse_input.rs) | Demonstrates handling a mouse button press/release
 `mouse_input_events` | [`input/mouse_input_events.rs`](./input/mouse_input_events.rs) | Prints out all mouse events (buttons, movement, etc.)
 `touch_input` | [`input/touch_input.rs`](./input/touch_input.rs) | Displays touch presses, releases, and cancels
-`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_input_events.rs) | Prints out all touch inputs
+`touch_input_events` | [`input/touch_input_events.rs`](./input/touch_input_events.rs) | Prints out all touch inputs
 
 ## Reflection
 
@@ -280,7 +280,9 @@ Please reference `cargo-apk` [README](https://crates.io/crates/cargo-apk) for ot
 
 ### Old phones
 
-Bevy by default targets Android API level 29 in its examples which is the [Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). Users of older phones may want to use an older API when testing.
+Bevy by default targets Android API level 29 in its examples which is the <!-- markdown-link-check-disable -->
+[Play Store's minimum API to upload or update apps](https://developer.android.com/distribute/best-practices/develop/target-sdk). <!-- markdown-link-check-enable -->
+Users of older phones may want to use an older API when testing.
 
 To use a different API, the following fields must be updated in Cargo.toml: