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 Apr 24, 2023
1 parent 62bc941 commit d8ea8f7
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions doc/quarto.txt
Original file line number Diff line number Diff line change
Expand Up @@ -125,13 +125,17 @@ or access the function from lua, e.g. to create a keybinding:

>lua
local quarto = require'quarto'
quarto.setup()
vim.keymap.set('n', '<leader>qp', quarto.quartoPreview, {silent = true, noremap = true})
<

Then use the keyboard shortcut to open `quarto preview` for the current file or
project in the active working directory in the neovim integrated terminal in a
new tab.

Note: While you can use `QuartoPreview` without configuring the plugin via
`quarto.setup`, other features strictly require it.


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

Expand All @@ -144,18 +148,9 @@ https://user-images.githubusercontent.com/17450586/209436101-4dd560f4-c876-4dbc-

USAGE ~

Enable quarto-nvim’s lsp features by configuring it with

>lua
require'quarto'.setup{
lspFeatures = {
enabled = true,
}
}
<

After enabling the language features, you can open the hover documentation for
R, python and julia code chunks with `K` (or configure a different shortcut).
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 ~
Expand Down Expand Up @@ -211,6 +206,8 @@ AVAILABLE COMMNDS *quarto-quarto-nvim-available-commnds*
QuartoActivate
QuartoDiagnostics
QuartoHover
QuartoSendAbove
QuartoSendAll
<


Expand Down

0 comments on commit d8ea8f7

Please sign in to comment.