Merge pull request #12 from yriveiro/markdown-lint

feat: add markdown lint GH action

.github/workflows/markdownlint-problem-matcher.json

@@ -0,0 +1,17 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "markdownlint",
+      "pattern": [
+        {
+          "regexp": "^([^:]*):(\\d+):?(\\d+)?\\s([\\w-\\/]*)\\s(.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "code": 4,
+          "message": 5
+        }
+      ]
+    }
+  ]
+}

.github/workflows/markdownlint.yaml

@@ -0,0 +1,34 @@
+name: Markdownlint
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "**/*.md"
+      - "**/*.mdx"
+      - ".markdownlint-cli2.jsonc"
+      - ".github/workflows/markdownlint.yml"
+      - ".github/workflows/markdownlint-problem-matcher.json"
+  pull_request:
+    paths:
+      - "**/*.md"
+      - "**/*.mdx"
+      - ".markdownlint-cli2.jsonc"
+      - ".github/workflows/markdownlint.yml"
+      - ".github/workflows/markdownlint-problem-matcher.json"
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    permissions:
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Run Markdownlint
+        run: |
+          echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json"
+          npm i -g markdownlint-cli2
+          markdownlint-cli2 "**/*.{md,mdx,markdown}"

.markdownlint-cli2.jsonc

@@ -0,0 +1,9 @@
+{
+  "config": {
+    "default": true,
+    "MD024": false,
+    "MD025": false,
+    "MD041": false
+  },
+  "ignores": [".github/"]
+}

README.md

@@ -1,6 +1,7 @@
 # dap-go.nvim
 
-Golang with Delve over Debug Adapter Protocol for [Neovim](https://neovim.io/) (>= 0.5)
+Golang with Delve over Debug Adapter Protocol for [Neovim](https://neovim.io/)
+(>= 0.5)
 
 # What is DAP Go
 
@@ -15,27 +16,30 @@ to configurate Go with Delve debugger.
 - [Installation](#installation)
 - [Contributing](#contributing)
 - [Changelog](https://github.com/yriveiro/dap-go.nvim/blob/master/doc/dap_go_changelog.md)
-- [Acknowledgement](#Acknowledgement)
+- [Acknowledgement](#acknowledgement)
 - [License](#license)
 
 ## Features
 
-* Load `dap` configurations from a file.
+- Load `dap` configurations from a file.
 
 ## Getting Started
 
-This section should guide you on how to add the extention to `nvim-dap`.
+This section should guide you on how to add the extension to `nvim-dap`.
 
 ### Dependencies
 
-* [Neovim (v.5.1)](https://github.com/neovim/neovim/releases/tag/v0.5.1) or higher.
-* [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) for all the stuff I don't want to write twice.
-* [Delve](https://github.com/go-delve/delve)
+- [Neovim (v.5.1)](https://github.com/neovim/neovim/releases/tag/v0.5.1) or higher.
+- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) for all the stuff I
+  don't want to write twice.
+- [Delve](https://github.com/go-delve/delve)
 
 ### Suggested Dependencies  
 
-* [telescope-dap](https://github.com/nvim-telescope/telescope-dap.nvim) to browse the `dap` configurations.
-* [nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui) for more user friendly DAP user interface.
+- [telescope-dap](https://github.com/nvim-telescope/telescope-dap.nvim) to browse
+  the `dap` configurations.
+- [nvim-dap-ui](https://github.com/rcarriga/nvim-dap-ui) for more user friendly
+  DAP user interface.
 
 ## Installation
 
@@ -84,9 +88,11 @@ require('dap-go').setup({
   }
 })
 ```
-
-An example of the `dap-go.json` file. This file can be used for custom configurations. 
-The default path to search for is the current directory or git (if the current project is using git) root.
+
+An example of the `dap-go.json` file. This file can be used for custom configurations.
+The default path to search for is the current directory or git (if the current project
+is using git) root.
+
 ```json
 {
   "Custom config": {
@@ -106,14 +112,16 @@ The default path to search for is the current directory or git (if the current p
   }
 }
 ```
+
 ## Contributing
 
 All contributions are welcome! Just open a pull request. Please read CONTRIBUTING.md
 
 ## Acknowledgement
 
-* [nvim-dap-go](https://github.com/leoluz/nvim-dap-go)
+- [nvim-dap-go](https://github.com/leoluz/nvim-dap-go)
 
 ## License
 
-Licensed under the MIT License. Check the [LICENSE](https://github.com/yriveiro/dap-go.nvim/blob/main/LICENSE) file for details.
+Licensed under the MIT License. Check the [LICENSE](https://github.com/yriveiro/dap-go.nvim/blob/main/LICENSE)
+file for details.