From 3a489be73597dc1ddc2c0d9901ab80fbded0151d Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Thu, 18 Aug 2022 10:06:56 +0200
Subject: [PATCH] Fix markdownlint warnings

---
 .github/workflows/linter.yml |  1 +
 .markdownlint.yaml           |  3 +++
 README.md                    | 15 +++------------
 3 files changed, 7 insertions(+), 12 deletions(-)
 create mode 100644 .markdownlint.yaml

diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
index 8dc4185..aa08df3 100644
--- a/.github/workflows/linter.yml
+++ b/.github/workflows/linter.yml
@@ -19,4 +19,5 @@ jobs:
         uses: github/super-linter/slim@v4
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          LINTER_RULES_PATH: /
           VALIDATE_JSCPD: false
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
new file mode 100644
index 0000000..570632d
--- /dev/null
+++ b/.markdownlint.yaml
@@ -0,0 +1,3 @@
+---
+MD013: false
+MD051: false
diff --git a/README.md b/README.md
index 25abd67..a5b5308 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,6 @@
 
 Extensions for the built-in [Language Server Protocol][1] support in [Neovim][2] (>= 0.6.0) for [eclipse.jdt.ls][3].
 
-
 ## Audience
 
 This project follows the [KISS principle][kiss] and targets users with some
@@ -34,14 +33,12 @@ alternative:
   - [x] Move package, instance method, static method or type
 - [x] `javap` command to show bytecode of current file
 - [x] `jol` command to show memory usage of current file (`jol_path` must be set)
-- [x] `jshell` command to open up jshell with classpath from project set
+- [x] `jshell` command to open up `jshell` with `classpath` from project set
 - [x] Debugger support via [nvim-dap][5]
 
-
 Take a look at [a demo](https://github.com/mfussenegger/nvim-jdtls/issues/3) to
 see some of the functionality in action.
 
-
 ## Plugin Installation
 
 - Requires Neovim (>= 0.6.0)
@@ -56,7 +53,7 @@ Install [eclipse.jdt.ls][3] by following their [Installation instructions](https
 ## Configuration
 
 To configure `nvim-jdtls`, add the following in `ftplugin/java.lua` within the
-neovim configuration base directory (e.g. `~/.config/nvim/ftplugin/java.lua`,
+Neovim configuration base directory (e.g. `~/.config/nvim/ftplugin/java.lua`,
 see `:help base-directory`).
 
 Watch out for the 💀, it indicates that you must adjust something.
@@ -172,10 +169,9 @@ local config = {
 `...` is not valid Lua in this context. It is meant as placeholder for the
 other options from the [Configuration](#configuration) section above.)
 
-
 ### nvim-lspconfig and nvim-jdtls differences
 
-Both nvim-lspconfig and nvim-jdtls use the client built into neovim:
+Both [nvim-lspconfig][9] and nvim-jdtls use the client built into neovim:
 
 ```txt
   ┌────────────┐           ┌────────────────┐
@@ -210,13 +206,11 @@ handling.
 You **must not** use both at the same time for java. You'd end up with two
 clients and two language server instances.
 
-
 ### UI picker customization
 
 **Tip**: You can get a better UI for code-actions and other functions by
 overriding the `jdtls.ui` picker. See [UI Extensions][10].
 
-
 ## Usage
 
 `nvim-jdtls` extends the capabilities of the built-in LSP support in
@@ -501,12 +495,9 @@ priority.
 [5]: https://github.com/mfussenegger/nvim-dap
 [6]: https://github.com/microsoft/java-debug
 [7]: https://github.com/microsoft/vscode-java-test
-[8]: https://github.com/eclipse/eclipse.jdt.ls/wiki/Running-the-JAVA-LS-server-from-the-command-line
 [9]: https://github.com/neovim/nvim-lspconfig
 [10]: https://github.com/mfussenegger/nvim-jdtls/wiki/UI-Extensions
 [11]: https://github.com/mfussenegger/nvim-jdtls/wiki/Sample-Configurations
-[12]: https://download.eclipse.org/jdtls/milestones/
-[13]: https://download.eclipse.org/jdtls/snapshots/?d
 [14]: https://github.com/junegunn/vim-plug
 [15]: https://github.com/wbthomason/packer.nvim
 [kiss]: https://en.wikipedia.org/wiki/KISS_principle