Repository: autozimu/LanguageClient-neovim (language: rust)

Issue:
Markdown files should be formatted consistently throughout this repository
The markdown files within this repository are not formatted, or at least not formatted consistently, making them hard to read. According to [the syntax guide][0], there are several improvements we can make:

* Line breaks around headers and code blocks (as well as in between paragraphs, if any exist)
* Consistent list item markers (`*` **or** `-`, not both)
* Remove numbered headers, and ordered, numbered lists where appropriate

[0]: https://daringfireball.net/projects/markdown/


Discussion / hints:

Fix patch:
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 83a7b4ae..59620138 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,29 +1,35 @@
 # Prerequisites
+
 - [rust] toolchain
 
 [rust]: https://www.rust-lang.org
 
 # Development
+
 Put those settings inside vimrc,
+
 ```vim
 let g:LanguageClient_devel = 1 " Use rust debug build
 let g:LanguageClient_loggingLevel = 'DEBUG' " Use highest logging level
 ```
 
-1. Make necessary changes.
-1. Build. `make` to build, format and run [clippy], or `make build` to run build only.
-1. Verify changes.
-1. Run tests. (See below section)
+- Make necessary changes.
+- Build. `make` to build, format and run [clippy], or `make build` to run build only.
+- Verify changes.
+- Run tests. (See below section)
 
 [clippy]: https://github.com/rust-lang-nursery/rust-clippy
 
 # Run tests
+
 (Option 1. Recommended) With docker installed,
+
 ```sh
 make test && make integration-test-docker
 ```
 
 (Option 2) Refer [`Dockerfile`](Dockerfile) to install tests dependencies.
+
 ```sh
 make test && make integration-test
 ```
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 8f9fdd92..28f2bf55 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -10,12 +10,14 @@ about: Create a report to help us improve
 - (Neovim users only) Did you check output of `:checkhealth LanguageClient`?
 - Did you check [troubleshooting]?
 
-[troubleshooting]: https://github.com/autozimu/LanguageClient-neovim/blob/next/INSTALL.md#6-troubleshooting
+[troubleshooting]: https://github.com/autozimu/LanguageClient-neovim/blob/next/INSTALL.md#troubleshooting
 
 ## Describe the bug
+
 A clear and concise description of what the bug is.
 
 ## Environment
+
 - neovim/vim version (`nvim --version` or `vim --version`):
 - This plugin version (`git rev-parse --short HEAD`):
 - This plugin's binary version (`bin/languageclient --version`):
@@ -26,21 +28,27 @@ A clear and concise description of what the bug is.
 [min-vimrc.vim]: https://github.com/autozimu/LanguageClient-neovim/blob/next/min-vimrc.vim
 
 ## To Reproduce
+
 Steps to reproduce the behavior:
-1. Create/Fetch example project ...
-1. Start vim, `nvim -u min-vimrc.vim` ...
-1. Edit ...
-1. Execute ....
-1. See error
+
+- Create/Fetch example project ...
+- Start vim, `nvim -u min-vimrc.vim` ...
+- Edit ...
+- Execute ....
+- See error
 
 ## Current behavior
+
 A clear and concise description of what's the current behavior.
 
 ## Expected behavior
+
 A clear and concise description of what you expected to happen.
 
 ## Screenshots
+
 If applicable, add screenshots to help explain your problem.
 
 ## Additional context
+
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 77eebe1f..09eb9fb2 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -5,13 +5,17 @@ about: Suggest an idea for this project
 ---
 
 ## Is your feature request related to a problem? Please describe.
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 ## Describe the solution you'd like
+
 A clear and concise description of what you want to happen.
 
 ## Describe alternatives you've considered
+
 A clear and concise description of any alternative solutions or features you've considered.
 
 ## Additional context
+
 Add any other context or screenshots about the feature request here.
diff --git a/INSTALL.md b/INSTALL.md
index c03d20c2..70b13d36 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,12 +1,13 @@
-# 1. Requirements
+# Requirements
+
 - neovim or
 - vim >= 8.0
 
-# 2. Install dependencies
+# Install dependencies
 
 None.
 
-# 3. Install this plugin
+# Install this plugin
 
 ## Linux
 
@@ -36,7 +37,9 @@ There are two packages available on the [AUR][archlinux/aur]
 > Android is not supported using the `install.sh` script.
 
 ## [vim-plug](https://github.com/junegunn/vim-plug) user
+
 Add following to vimrc
+
 ```vim
 Plug 'autozimu/LanguageClient-neovim', {
     \ 'branch': 'next',
@@ -47,7 +50,9 @@ Plug 'autozimu/LanguageClient-neovim', {
 Restart neovim and run `:PlugInstall` to install.
 
 ## [dein.vim](https://github.com/Shougo/dein.vim) user
+
 Add following to vimrc
+
 ```vim
 call dein#add('autozimu/LanguageClient-neovim', {
     \ 'rev': 'next',
@@ -58,7 +63,9 @@ call dein#add('autozimu/LanguageClient-neovim', {
 Restart neovim and run `:call dein#install()` to install.
 
 ## Manual
+
 Clone this repo into some place, e.g., `~/.vim-plugins`
+
 ```sh
 mkdir -p ~/.vim-plugins
 cd ~/.vim-plugins
@@ -68,18 +75,22 @@ bash install.sh
 ```
 
 Add this plugin to vim/neovim `runtimepath`,
+
 ```vim
 set runtimepath+=~/.vim-plugins/LanguageClient-neovim
 ```
 
-# 4. Install language servers
+# Install language servers
+
 Install language servers if corresponding language servers are not available
 yet on your system. Please see <http://langserver.org> and/or
 <https://github.com/Microsoft/language-server-protocol/wiki/Protocol-Implementations>
 for list of language servers.
 
-# 5. Configure this plugin
+# Configure this plugin
+
 Example configuration
+
 ```vim
 " Required for operations modifying multiple buffers like rename.
 set hidden
@@ -97,12 +108,13 @@ nnoremap <silent> gd :call LanguageClient#textDocument_definition()<CR>
 nnoremap <silent> <F2> :call LanguageClient#textDocument_rename()<CR>
 ```
 
-# 6. Troubleshooting
+# Troubleshooting
 
-1. Backup your vimrc and use [min-vimrc.vim](min-vimrc.vim) as vimrc.
-1. Try on [sample projects](tests/data).
-1. Execute `:echo &runtimepath` and make sure the plugin path is in the list.
-1. Make sure language server could be started when invoked manually from shell.
- Also try use absolute path for server commands, as PATH in vim might be different from shell env, especially on macOS.
-1. Check content of log file. Also worth noting language server might have
-   separate log file.
+- Backup your vimrc and use [min-vimrc.vim](min-vimrc.vim) as vimrc.
+- Try on [sample projects](tests/data).
+- Execute `:echo &runtimepath` and make sure the plugin path is in the list.
+- Make sure language server could be started when invoked manually from shell.
+  Also try use absolute path for server commands, as PATH in vim might be
+  different from shell env, especially on macOS.
+- Check content of log file. Also worth noting language server might have
+  separate log file.
diff --git a/README.md b/README.md
index b43f0e52..67752134 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 > For legacy python implementation, see [branch master](https://github.com/autozimu/LanguageClient-neovim/tree/master).
 
 # LanguageClient-neovim
+
 [![CircleCI](https://circleci.com/gh/autozimu/LanguageClient-neovim.svg?style=svg)](https://circleci.com/gh/autozimu/LanguageClient-neovim)
 
 [Language Server Protocol] (LSP) support for [vim] and [neovim].
@@ -74,7 +75,7 @@ language services will be available right away. Happy hacking!
 
 # Troubleshooting
 
-[Troubleshooting](INSTALL.md#6-troubleshooting)
+[Troubleshooting](INSTALL.md#troubleshooting)
 
 # Language Servers
 
@@ -90,6 +91,7 @@ to install them, please see <http://langserver.org> and/or
 [LanguageClient.txt]: doc/LanguageClient.txt
 
 # Changelog
+
 See [Updates]. Subscribe the issue if you want to receive notifications.
 
 [Updates]: https://github.com/autozimu/LanguageClient-neovim/issues/35


Test patch: