Makussu/jdhao-nvim-config
1
0
Fork 0
mirror of https://github.com/jdhao/nvim-config.git synced 2025-06-08 14:14:33 +02:00
Code Issues Projects Releases Wiki Activity

fix doc syntax issues

Browse Source
This commit is contained in:
jdhao 2020-09-24 23:09:08 +08:00
parent 00cbed4cdc
commit f86a851a9e
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -5,18 +5,18 @@
# Introduction # Introduction
This is my Neovim configuration for all the platforms I use (Linux, Windows and This is my Neovim configuration for all the platforms I use (Linux, Windows and
MacOS). `init.vim` is the config file for terminal Neovim, and `ginit.vim` is macOS). `init.vim` is the config file for terminal Neovim, and `ginit.vim` is
the additional config file for GUI client of Neovim (I am using the additional config file for GUI client of Neovim (I am using
[neovim-qt](https://github.com/equalsraf/neovim-qt) for now on Windows). [neovim-qt](https://github.com/equalsraf/neovim-qt) for now on Windows).
My configurations are heavily documented to make it as clear as possible. While My configurations are heavily documented to make it as clear as possible. While
you can download the whole repository and use it, it is not recommended to do you can download the whole repository and use it, it is not recommended though.
so. Good configurations are personal. Everyone should have his or her unique Good configurations are personal. Everyone should have his or her unique config
config file. You are encouraged to copy from this this repo the part you feel file. You are encouraged to copy from this this repo the part you feel useful
useful and add it to your own Nvim config. and add it to your own Nvim config.
See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim See [doc here](docs/README.md) on how to install Nvim's dependencies, Nvim
itself and the configuration on different platforms (Linux, MacOS and Windows). itself and the configuration on different platforms (Linux, macOS and Windows).
# Features # # Features #

12
docs/README.md
View File

@ -69,7 +69,7 @@ page](https://github.com/BurntSushi/ripgrep/releases) and install it.
## Linters ## Linters
A linter is a tool to check the source code for possible style and syntatic A linter is a tool to check the source code for possible style and syntax
issues. Based on the programming languages we use, we may need to install issues. Based on the programming languages we use, we may need to install
various linters. various linters.
@ -126,7 +126,7 @@ The easiest way to install Neovim on Windows is via
we can install neovim easily with we can install neovim easily with
``` ```
# install latest version of neovim # install the latest version of neovim
# choco install neovim --pre # choco install neovim --pre
choco install neovim choco install neovim
@ -139,13 +139,13 @@ from GitHub and manually extract it.
## Mac ## Mac
It is recommended to install neovim via [Homebrew](https://brew.sh/) on MacOS. It is recommended to install neovim via [Homebrew](https://brew.sh/) on macOS.
Simply run the following command: Simply run the following command:
``` ```
brew install neovim brew install neovim
# If you want to install latest version of neovim, use the following command # If you want to install the latest version of neovim, use the following
# instead. # command instead.
# brew install --HEAD neovim # brew install --HEAD neovim
``` ```
@ -153,7 +153,7 @@ After installing Neovim, we need to add the directory where the Neovim
executable (`nvim` on Linux and Mac, `nvim.exe` on Windows) resides to the executable (`nvim` on Linux and Mac, `nvim.exe` on Windows) resides to the
system `PATH`. system `PATH`.
Make sure that you can call `nvim` from the command line after all these setup. Make sure that you can call `nvim` from the command line after all these setups.
# Setting up Nvim # Setting up Nvim

4
tools/README.md
View File

@ -1,2 +1,2 @@
For the detail on how to set up `markdown2ctags.py` for showing Markdown tags in tagbar, For the detail on how to set up `markdown2ctags.py` to show Markdown tags
see [this post](https://jdhao.github.io/2019/10/15/tagbar_markdown_setup/). in tagbar, see [this post](https://jdhao.github.io/2019/10/15/tagbar_markdown_setup/).