Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 30, 2024
1 parent f733146 commit f932e13
Showing 1 changed file with 15 additions and 39 deletions.
54 changes: 15 additions & 39 deletions doc/quarto.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*quarto.txt* For Neovim >= 0.8.0 Last change: 2024 June 29
*quarto.txt* For Neovim >= 0.8.0 Last change: 2024 June 30

==============================================================================
Table of Contents *quarto-table-of-contents*
Expand Down Expand Up @@ -37,11 +37,7 @@ manager like lazy.nvim <https://github.com/folke/lazy.nvim>, packer.nvim
<https://github.com/junegunn/vim-plug>.

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

As such, we recommend you to experiment with the quarto-nvim kickstarter
existing plugins, we recommend to experiment with the quarto-nvim kickstarter
configuration <https://github.com/jmbuhr/quarto-nvim-kickstarter> and then pick
the relevant parts from the `lua/plugins/quarto.lua`
<https://github.com/jmbuhr/quarto-nvim-kickstarter/blob/main/lua/plugins/quarto.lua>
Expand Down Expand Up @@ -113,16 +109,6 @@ or with an empty table.
-- Takes precedence over `default_method`
never_run = { "yaml" }, -- filetypes which are never sent to a code runner
},
keymap = {
-- set whole section or individual keys to `false` to disable
hover = "K",
definition = "gd",
type_definition = "gD",
rename = "<leader>lR",
format = "<leader>lf",
references = "gr",
document_symbols = "gS",
}
}
<

Expand Down Expand Up @@ -153,6 +139,9 @@ Note: While you can use `QuartoPreview` without configuring the plugin via

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

`quarto-nvim` automatically activates `otter.nvim` for quarto files if language
features are enabled.


DEMO ~

Expand All @@ -162,25 +151,13 @@ https://user-images.githubusercontent.com/17450586/209436101-4dd560f4-c876-4dbc-

USAGE ~

With the language features enabled, you can open the hover documentation for R,
python and julia code chunks with `K` (or configure a different shortcut). You
can got-to-definition with `gd`.


AUTOCOMPLETION ~
Uou can open the hover documentation for R, python and julia code chunks with
`K`, got-to-definition with `gd` etc. and get autocompletion via the lsp source
for your completion plugin.

`quarto-nvim` now comes with a completion source for nvim-cmp
<https://github.com/hrsh7th/nvim-cmp> to deliver swift autocompletion for code
in quarto code chunks. With the quarto language features enabled, you can add
the source in your `cmp` configuration:

>lua
-- ...
sources = {
{ name = 'otter' },
}
-- ...
<
A list of currently available language server requests can be found in the
[otter.nvim
documentation(https://github.com/jmbuhr/otter.nvim?tab=readme-ov-file#lsp-methods-currently-implemented).


R DIAGNOSTICS CONFIGURATION ~
Expand Down Expand Up @@ -278,12 +255,11 @@ AVAILABLE COMMANDS *quarto-quarto-nvim-available-commands*

RECOMMENDED PLUGINS *quarto-quarto-nvim-recommended-plugins*

Quarto works great with a number of existing plugins in the neovim ecosystem.
You can find semi-opinionated but still minimal configurations for `nvim` and
`tmux`, for use with Quarto, R and python in these two repositories:
Quarto works great with a number of plugins in the neovim ecosystem. You can
find my personal (and thus up-to-date) configuration for use with Quarto, R and
python here:

- <https://github.com/jmbuhr/quarto-nvim-kickstarter>
- <https://github.com/jmbuhr/tmux-kickstarter>
<https://github.com/jmbuhr/quarto-nvim-kickstarter>

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

Expand Down

0 comments on commit f932e13

Please sign in to comment.