Skip to content

Add installation instructions for Neovim #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 23, 2022
Merged

Add installation instructions for Neovim #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,26 @@ quarto-vim's repo uses the typical bundle layout, so it's very simple to
install using some plugin manager such as [pathogen](https://github.com/tpope/vim-pathogen), [Vundle](https://github.com/VundleVim/Vundle.vim) or [NeoBundle](https://github.com/Shougo/neobundle.vim). For
example, using Vundle you should add

Plugin 'vim-pandoc/vim-pandoc-sytnax'
Plugin 'quarto-dev/quarto-vim'
```viml
Plugin 'vim-pandoc/vim-pandoc-syntax'
Plugin 'quarto-dev/quarto-vim'
```

to your .vimrc, source it, and execute `:PluginInstall`.

Using [packer.nvim](https://github.com/wbthomason/packer.nvim), you should add

```lua
use({
"quarto-dev/quarto-vim",
requires = {
{"vim-pandoc/vim-pandoc-syntax"},
},
ft = {"quarto"},
})
```
to your `.vimrc` (or `init.lua` in Neovim).

## Usage

Files with the .qmd extension are automatically detected as Quarto files and use highlithing rules from vim-pandoc-syntax (in addition to some special rules for Quarto executable code).
Expand Down