Add markdownlint

Add a Markdown linter.
martincostello · Sep 28, 2024 · abfc544 · abfc544
1 parent e10a3e2
commit abfc544
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 5 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,7 +4,6 @@ about: Create a bug report to help us improve the library
 title: ''
 labels: 'bug'
 assignees: ''
-
 ---
 
 <!--
@@ -33,7 +32,7 @@ assignees: ''
 
 ## System information
 
-- OS: [e.g. Windows 10]
+- OS: [e.g. Windows 11]
 - Library Version [e.g. 0.1.0]
 - .NET version [e.g. output from `dotnet --info`]
 - IDE and version [e.g. Visual Studio 16.3.7]

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,7 +4,6 @@ about: Suggest an idea for a feature of this library
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
 <!--

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -37,3 +37,10 @@ jobs:
       uses: docker://rhysd/actionlint@sha256:89d3f90f82781dee3c8724651129634b08cf2241bbd67fcd02a1c5198119fc5e # v1.7.2
       with:
         args: -color
+
+    - name: Lint markdown
+      uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v17.0.0
+      with:
+        config: '.markdownlint.json'
+        globs: |
+          **/*.md
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD040": false
+}
diff --git a/README.md b/README.md
@@ -441,15 +441,15 @@ Any feedback or issues can be added to the issues for this project in [GitHub](h
 
 ## Repository
 
-The repository is hosted in [GitHub](https://github.com/martincostello/lambda-test-server "This project on GitHub.com"): [https://github.com/martincostello/lambda-test-server.git](https://github.com/martincostello/lambda-test-server.git)
+The repository is hosted in [GitHub](https://github.com/martincostello/lambda-test-server "This project on GitHub.com"): <https://github.com/martincostello/lambda-test-server.git>
 
 ## License
 
 This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt "The Apache 2.0 license") license.
 
 ## Building and Testing
 
-Compiling the library yourself requires Git and the [.NET SDK](https://dotnet.microsoft.com/en-us/download "Download the .NET SDK") to be installed.
+Compiling the library yourself requires Git and the [.NET SDK](https://dotnet.microsoft.com/download "Download the .NET SDK") to be installed.
 
 To build and test the library locally from a terminal/command-line, run one of the following set of commands:
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,7 +4,6 @@ about: Suggest an idea for a feature of this library @@
     title: ''
     labels: ''
     assignees: ''
     ---
     <!--
@@ Expand Down @@