Skip to content

Commit 6c19600

Browse files
github-actions[bot]github-actions[bot]
committed
chore(build): auto-generate vimdoc
1 parent ac9bafe commit 6c19600

File tree

1 file changed

+55
-97
lines changed

1 file changed

+55
-97
lines changed

‎doc/quarto.txt‎

Lines changed: 55 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
*quarto.txt* For Neovim >= 0.8.0 Last change: 2023 April 04
1+
*quarto.txt* For Neovim >= 0.8.0 Last change: 2023 April 09
22

33
==============================================================================
44
Table of Contents *quarto-table-of-contents*
55

66
1. quarto-nvim |quarto-quarto-nvim|
77
- Setup |quarto-quarto-nvim-setup|
88
- Usage |quarto-quarto-nvim-usage|
9-
- Configure |quarto-quarto-nvim-configure|
109
- Language support |quarto-quarto-nvim-language-support|
1110
- Available Commnds |quarto-quarto-nvim-available-commnds|
1211
- Recommended Plugins |quarto-quarto-nvim-recommended-plugins|
@@ -15,129 +14,70 @@ Table of Contents *quarto-table-of-contents*
1514
1. quarto-nvim *quarto-quarto-nvim*
1615

1716
Quarto-nvim provides tools for working on quarto <https://quarto.org/>
18-
manuscripts in neovim.
17+
manuscripts in Neovim.
1918

20-
**Note**Some functionality has been refactored into its own library otter.nvim
21-
<https://github.com/jmbuhr/otter.nvim> for better extensibility.
19+
Quarto-nvim requires Neovim >= **v0.9.0**
20+
(https://github.com/neovim/neovim/releases/tag/stable).
2221

2322

2423
SETUP *quarto-quarto-nvim-setup*
2524

26-
Install the plugin from GitHub with your favourite neovim plugin manager. With
27-
example configuration:
25+
You can install `quarto-nvim` from GitHub with your favourite Neovim plugin
26+
manager like lazy.nvim <https://github.com/folke/lazy.nvim>, packer.nvim
27+
<https://github.com/wbthomason/packer.nvim> or VimPlug
28+
<https://github.com/junegunn/vim-plug>.
2829

30+
Because Quarto provides a lot of functionality through integration with
31+
existing plugins, some of those have to be told about the existence of
32+
`quarto-nvim` (like e.g. registering it as a source for the autocompletion
33+
plugin `nvim-cmp`).
2934

30-
PACKER.NVIM ~
35+
As such, we recommend you to experiment with the quarto-nvim kickstarter
36+
configuration <https://github.com/jmbuhr/quarto-nvim-kickstarter> and then pick
37+
the relevant parts from the `lua/plugins/quarto.lua`
38+
<https://github.com/jmbuhr/quarto-nvim-kickstarter/blob/main/lua/plugins/quarto.lua>
39+
file to integrate it into your own existing configuration.
3140

32-
>lua
33-
use { 'quarto-dev/quarto-nvim',
34-
requires = {
35-
'jmbuhr/otter.nvim',
36-
'hrsh7th/nvim-cmp',
37-
'neovim/nvim-lspconfig',
38-
'nvim-treesitter/nvim-treesitter'
39-
},
40-
config = function()
41-
require 'quarto'.setup {
42-
lspFeatures = {
43-
enabled = true,
44-
languages = { 'r', 'python', 'julia' },
45-
diagnostics = {
46-
enabled = true,
47-
triggers = { "BufWrite" }
48-
},
49-
completion = {
50-
enabled = true
51-
}
52-
}
53-
}
54-
end
55-
}
56-
<
57-
58-
59-
LAZY.NVIM ~
41+
Plugins and their configuration to look out for in this file are:
6042

6143
>lua
62-
{ 'quarto-dev/quarto-nvim',
63-
dependencies = {
64-
'jmbuhr/otter.nvim',
65-
'hrsh7th/nvim-cmp',
66-
'neovim/nvim-lspconfig',
67-
'nvim-treesitter/nvim-treesitter'
68-
},
69-
config = function()
70-
require 'quarto'.setup {
71-
lspFeatures = {
72-
enabled = true,
73-
languages = { 'r', 'python', 'julia' },
74-
diagnostics = {
75-
enabled = true,
76-
triggers = { "BufWrite" }
77-
},
78-
completion = {
79-
enabled = true
80-
}
81-
}
82-
}
83-
end
84-
},
85-
<
86-
87-
88-
VIM-PLUG ~
89-
90-
>vim
91-
Plug 'quarto-dev/quarto-nvim'
92-
Plug 'neovim/nvim-lspconfig'
93-
Plug 'jmbuhr/otter.nvim'
94-
Plug 'hrsh7th/nvim-cmp'
95-
Plug 'nvim-treesitter/nvim-treesitter'
44+
{
45+
'quarto-dev/quarto-nvim',
46+
'jmbuhr/otter.nvim',
47+
'hrsh7th/nvim-cmp',
48+
'neovim/nvim-lspconfig',
49+
'nvim-treesitter/nvim-treesitter'
50+
}
9651
<
9752

9853

9954
USAGE *quarto-quarto-nvim-usage*
10055

10156

102-
PREVIEW ~
103-
104-
Use the command
105-
106-
>vim
107-
QuartoPreview
108-
<
109-
110-
or access the function from lua, e.g. to create a keybinding:
111-
112-
>lua
113-
local quarto = require'quarto'
114-
vim.keymap.set('n', '<leader>qp', quarto.quartoPreview, {silent = true, noremap = true})
115-
<
116-
117-
Then use the keyboard shortcut to open `quarto preview` for the current file or
118-
project in the active working directory in the neovim integrated terminal in a
119-
new tab.
120-
57+
CONFIGURE ~
12158

122-
CONFIGURE *quarto-quarto-nvim-configure*
59+
You can pass a lua table with options to the setup function as shown in
60+
quarto-nvim-kickstarter/..quarto.lua
61+
<https://github.com/jmbuhr/quarto-nvim-kickstarter/blob/main/lua/plugins/quarto.lua>
12362

124-
You can pass a lua table with options to the setup function. It will be merged
125-
with the default options, which are shown below in the example:
63+
It will be merged with the default options, which are shown below in the
64+
example. If you want to use the defaults, simply call `setup` without arguments
65+
or with an empty table.
12666

12767
>lua
12868
require'quarto'.setup{
12969
debug = false,
13070
closePreviewOnExit = true,
13171
lspFeatures = {
132-
enabled = false,
133-
languages = { 'r', 'python', 'julia' },
72+
enabled = true,
73+
languages = { 'r', 'python', 'julia', 'bash' },
13474
chunks = 'curly', -- 'curly' or 'all'
13575
diagnostics = {
13676
enabled = true,
137-
triggers = { "BufWrite" }
77+
triggers = { "BufWritePost" }
13878
},
13979
completion = {
140-
enabled = false,
80+
enabled = true,
14181
},
14282
},
14383
keymap = {
@@ -147,7 +87,25 @@ with the default options, which are shown below in the example:
14787
}
14888
<
14989

150-
If you only need `QuartoPreview`, you don’t have to call the setup function.
90+
91+
PREVIEW ~
92+
93+
Use the command
94+
95+
>vim
96+
QuartoPreview
97+
<
98+
99+
or access the function from lua, e.g. to create a keybinding:
100+
101+
>lua
102+
local quarto = require'quarto'
103+
vim.keymap.set('n', '<leader>qp', quarto.quartoPreview, {silent = true, noremap = true})
104+
<
105+
106+
Then use the keyboard shortcut to open `quarto preview` for the current file or
107+
project in the active working directory in the neovim integrated terminal in a
108+
new tab.
151109

152110

153111
LANGUAGE SUPPORT *quarto-quarto-nvim-language-support*

0 commit comments

Comments
 (0)