1- *quarto.txt* For Neovim >= 0.8.0 Last change: 2024 December 04
1+ *quarto.txt* For Neovim >= 0.8.0 Last change: 2024 December 20
22
33==============================================================================
44Table of Contents *quarto-table-of-contents*
@@ -11,6 +11,7 @@ Table of Contents *quarto-table-of-contents*
1111 - Running Code | quarto-quarto-nvim-running-code |
1212 - Available Commands | quarto-quarto-nvim-available-commands |
1313 - Recommended Plugins | quarto-quarto-nvim-recommended-plugins |
14+ 2. Links | quarto-links |
1415
1516==============================================================================
16171. quarto-nvim *quarto-quarto-nvim*
@@ -104,11 +105,11 @@ or with an empty table.
104105 },
105106 },
106107 codeRunner = {
107- enabled = false ,
108- default_method = nil , -- ' molten' , ' slime' , or 'iron'
108+ enabled = true ,
109+ default_method = "slime" , -- " molten", " slime", "iron" or <function>
109110 ft_runners = {}, -- filetype to runner, ie. `{ python = "molten" }`.
110- -- Takes precedence over `default_method`
111- never_run = { " yaml" }, -- filetypes which are never sent to a code runner
111+ -- Takes precedence over `default_method`
112+ never_run = { ' yaml' }, -- filetypes which are never sent to a code runner
112113 },
113114 }
114115<
@@ -193,31 +194,33 @@ RUNNING CODE *quarto-quarto-nvim-running-code*
193194
194195Quarto-nvim doesn’t run code for you, instead, it will interface with
195196existing code running plugins and tell them what to run. There are currently
196- two such code running plugins that quarto will work with: 1. molten-nvim
197- <https://github.com/benlubas/molten-nvim > - a code runner that supports the
198- jupyter kernel, renders output below each code cell, and optionally renders
199- images in the terminal. 2. vim-slime <https://github.com/jpalardy/vim-slime > -
200- a general purpose code runner with support for sending code to integrated nvim
201- terminals, tmux panes, and many others. 3. Iron.nvim
202- <https://github.com/Vigemus/iron.nvim > general purpose code runner and library
203- for within-neovim REPL interaction in splits or floating windows.
204-
205- I recommend picking a code runner, setting it up based on its README, and then
206- coming back to this point to learn how Quarto will augment that code runner.
197+ three such code running plugins that quarto will work with:
198+
199+ 1. molten-nvim <https://github.com/benlubas/molten-nvim > - a code runner that supports the jupyter
200+ kernel, renders output below each code cell, and optionally renders images in the terminal.
201+ 2. vim-slime <https://github.com/jpalardy/vim-slime > - a general purpose code runner with support
202+ for sending code to integrated nvim terminals, tmux panes, and many others.
203+ 3. iron.nvim <https://github.com/Vigemus/iron.nvim > - general purpose code runner and library for
204+ within-neovim REPL interaction in splits or floating windows.
205+
206+ We recommend picking a code runner, setting it up based on its respective
207+ README and then coming back to this point to learn how Quarto will augment that
208+ code runner.
207209
208210This plugin enables easily sending code cells to your code runner. There are
209211two different ways to do this: commands, covered below; and lua functions,
210212covered right here. _By default these functions will only run cells that are
211213the same language as the current cell._
212214
213215Quarto exposes code running functions through to runner module:
214- `require (' quarto.runner' )` . Those functions are: - `run_cell ()` - runs the
215- current cell - `run_above (multi_lang)` - runs all the cells above the current
216- one, **and** the current one, in order - `run_below (multi_lang)` - runs all the
217- cells below the current one, **and** the current one, in order -
218- `run_all (multi_lang)` - runs all the cells in the document -
219- `run_line (multi_lang)` - runs the line of code at your cursor - `run_range ()` -
220- run code inside the visual range
216+ `require (' quarto.runner' )` . Those functions are:
217+
218+ - `run_cell ()` - runs the current cell
219+ - `run_above (multi_lang)` - runs all the cells above the current one, **and** the current one, in order
220+ - `run_below (multi_lang)` - runs all the cells below the current one, **and** the current one, in order
221+ - `run_all (multi_lang)` - runs all the cells in the document
222+ - `run_line (multi_lang)` - runs the line of code at your cursor
223+ - `run_range ()` - run code inside the visual range
221224
222225Each function that takes the optional `multi_lang` argument will run cells of
223226all languages when called with the value `true` , and will only run cells that
@@ -258,11 +261,18 @@ AVAILABLE COMMANDS *quarto-quarto-nvim-available-commands*
258261RECOMMENDED PLUGINS *quarto-quarto-nvim-recommended-plugins*
259262
260263Quarto works great with a number of plugins in the neovim ecosystem. You can
261- find my personal (and thus up-to-date) configuration for use with Quarto, R and
262- python here:
264+ find my (@jmbuhr) personal (and thus up-to-date) configuration for use with
265+ Quarto, R and python here:
263266
264267<https://github.com/jmbuhr/quarto-nvim-kickstarter >
265268
269+ But remember, the best config is always your own.
270+
271+ ==============================================================================
272+ 2. Links *quarto-links*
273+
274+ 1. *@jmbuhr*:
275+
266276Generated by panvimdoc <https://github.com/kdheepak/panvimdoc >
267277
268278vim:tw=78:ts=8:noet:ft=help:norl:
0 commit comments