Skip to content

Commit cf43a9f

Browse files
Benjamin Denhartogautozimu
Benjamin Denhartog
authored andcommitted
chore(docs): ensure each header and code block are separated from other content by a newline
closes #985
1 parent 9719e04 commit cf43a9f

File tree

5 files changed

+31
-0
lines changed

5 files changed

+31
-0
lines changed

Diff for: .github/CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# Prerequisites
2+
23
- [rust] toolchain
34

45
[rust]: https://www.rust-lang.org
56

67
# Development
8+
79
Put those settings inside vimrc,
10+
811
```vim
912
let g:LanguageClient_devel = 1 " Use rust debug build
1013
let g:LanguageClient_loggingLevel = 'DEBUG' " Use highest logging level
@@ -18,12 +21,15 @@ let g:LanguageClient_loggingLevel = 'DEBUG' " Use highest logging level
1821
[clippy]: https://github.com/rust-lang-nursery/rust-clippy
1922

2023
# Run tests
24+
2125
(Option 1. Recommended) With docker installed,
26+
2227
```sh
2328
make test && make integration-test-docker
2429
```
2530

2631
(Option 2) Refer [`Dockerfile`](Dockerfile) to install tests dependencies.
32+
2733
```sh
2834
make test && make integration-test
2935
```

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+8
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ about: Create a report to help us improve
1313
[troubleshooting]: https://github.com/autozimu/LanguageClient-neovim/blob/next/INSTALL.md#troubleshooting
1414

1515
## Describe the bug
16+
1617
A clear and concise description of what the bug is.
1718

1819
## Environment
20+
1921
- neovim/vim version (`nvim --version` or `vim --version`):
2022
- This plugin version (`git rev-parse --short HEAD`):
2123
- This plugin's binary version (`bin/languageclient --version`):
@@ -26,21 +28,27 @@ A clear and concise description of what the bug is.
2628
[min-vimrc.vim]: https://github.com/autozimu/LanguageClient-neovim/blob/next/min-vimrc.vim
2729

2830
## To Reproduce
31+
2932
Steps to reproduce the behavior:
33+
3034
- Create/Fetch example project ...
3135
- Start vim, `nvim -u min-vimrc.vim` ...
3236
- Edit ...
3337
- Execute ....
3438
- See error
3539

3640
## Current behavior
41+
3742
A clear and concise description of what's the current behavior.
3843

3944
## Expected behavior
45+
4046
A clear and concise description of what you expected to happen.
4147

4248
## Screenshots
49+
4350
If applicable, add screenshots to help explain your problem.
4451

4552
## Additional context
53+
4654
Add any other context about the problem here.

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ about: Suggest an idea for this project
55
---
66

77
## Is your feature request related to a problem? Please describe.
8+
89
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
910

1011
## Describe the solution you'd like
12+
1113
A clear and concise description of what you want to happen.
1214

1315
## Describe alternatives you've considered
16+
1417
A clear and concise description of any alternative solutions or features you've considered.
1518

1619
## Additional context
20+
1721
Add any other context or screenshots about the feature request here.

Diff for: INSTALL.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Requirements
2+
23
- neovim or
34
- vim >= 8.0
45

@@ -36,7 +37,9 @@ There are two packages available on the [AUR][archlinux/aur]
3637
> Android is not supported using the `install.sh` script.
3738
3839
## [vim-plug](https://github.com/junegunn/vim-plug) user
40+
3941
Add following to vimrc
42+
4043
```vim
4144
Plug 'autozimu/LanguageClient-neovim', {
4245
\ 'branch': 'next',
@@ -47,7 +50,9 @@ Plug 'autozimu/LanguageClient-neovim', {
4750
Restart neovim and run `:PlugInstall` to install.
4851

4952
## [dein.vim](https://github.com/Shougo/dein.vim) user
53+
5054
Add following to vimrc
55+
5156
```vim
5257
call dein#add('autozimu/LanguageClient-neovim', {
5358
\ 'rev': 'next',
@@ -58,7 +63,9 @@ call dein#add('autozimu/LanguageClient-neovim', {
5863
Restart neovim and run `:call dein#install()` to install.
5964

6065
## Manual
66+
6167
Clone this repo into some place, e.g., `~/.vim-plugins`
68+
6269
```sh
6370
mkdir -p ~/.vim-plugins
6471
cd ~/.vim-plugins
@@ -68,18 +75,22 @@ bash install.sh
6875
```
6976

7077
Add this plugin to vim/neovim `runtimepath`,
78+
7179
```vim
7280
set runtimepath+=~/.vim-plugins/LanguageClient-neovim
7381
```
7482

7583
# Install language servers
84+
7685
Install language servers if corresponding language servers are not available
7786
yet on your system. Please see <http://langserver.org> and/or
7887
<https://github.com/Microsoft/language-server-protocol/wiki/Protocol-Implementations>
7988
for list of language servers.
8089

8190
# Configure this plugin
91+
8292
Example configuration
93+
8394
```vim
8495
" Required for operations modifying multiple buffers like rename.
8596
set hidden

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
> For legacy python implementation, see [branch master](https://github.com/autozimu/LanguageClient-neovim/tree/master).
22
33
# LanguageClient-neovim
4+
45
[![CircleCI](https://circleci.com/gh/autozimu/LanguageClient-neovim.svg?style=svg)](https://circleci.com/gh/autozimu/LanguageClient-neovim)
56

67
[Language Server Protocol] (LSP) support for [vim] and [neovim].
@@ -90,6 +91,7 @@ to install them, please see <http://langserver.org> and/or
9091
[LanguageClient.txt]: doc/LanguageClient.txt
9192

9293
# Changelog
94+
9395
See [Updates]. Subscribe the issue if you want to receive notifications.
9496

9597
[Updates]: https://github.com/autozimu/LanguageClient-neovim/issues/35

0 commit comments

Comments
 (0)