add markdown link checker for the generated package

Author: fdiblen

{{cookiecutter.project_name}}/.github/workflows/markdown-link-check.yml

@@ -0,0 +1,14 @@
+name: markdown-link-check
+
+on: [push, pull_request]
+
+jobs:
+
+  markdown-link-check:
+    name: Check markdown links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@main
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        config-file: '.mlc-config.json'

{{cookiecutter.project_name}}/.mlc-config.json

@@ -0,0 +1,16 @@
+{
+    "_comment": "Markdown Link Checker configuration, see https://github.com/gaurav-nelson/github-action-markdown-link-check and https://github.com/tcort/markdown-link-check",
+    "ignorePatterns": [
+        {
+            "pattern": "^http://localhost"
+        },
+        {
+          "pattern": "^https://doi.org/<replace-with-created-DOI>"
+        },
+        {
+          "pattern": "^https://bestpractices.coreinfrastructure.org/projects/<replace-with-created-project-identifier>"
+        }
+    ],
+    "replacementPatterns": [
+    ]
+}

{{cookiecutter.project_name}}/README.md

@@ -19,6 +19,7 @@
 | Lint                               | [![lint]({{cookiecutter.repository}}/actions/workflows/lint.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/lint.yml) |
 | Publish                            | [![publish]({{cookiecutter.repository}}/actions/workflows/publish.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/publish.yml) |
 | SonarCloud                         | [![sonarcloud]({{cookiecutter.repository}}/actions/workflows/sonarcloud.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/sonarcloud.yml) |
+| MarkDown link checker              | [![markdown-link-check]({{cookiecutter.repository}}/actions/workflows/markdown-link-check.yml/badge.svg)]({{cookiecutter.repository}}/actions/workflows/markdown-link-check.yml) |
 
 ## How to use {{ cookiecutter.package_name }}