Skip to content

Commit 6f47ac4

Browse files
author
github-actions
committed
chore(docs): Update docs
1 parent 8291ba6 commit 6f47ac4

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

doc/orgmode.txt

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1559,6 +1559,12 @@ and `:help /magic`. Pressing `<TAB>` in filter prompt autocompletes categories
15591559
and tags.
15601560

15611561

1562+
org_agenda_preview *orgmode-org_agenda_preview*
1563+
1564+
- Mapped to: `K`
1565+
Preview the agenda item in a floating window. For configuring the floating window, check |orgmode-agenda-section-in-ui-configuration|.
1566+
1567+
15621568
org_agenda_show_help *orgmode-org_agenda_show_help*
15631569

15641570
- Mapped to: `g?`
@@ -3010,9 +3016,6 @@ this to config:
30103016

30113017
Input *orgmode-Input*
30123018

3013-
- Type: `boolean`
3014-
- Default: `false`
3015-
30163019
By default, Vim's built-in `input()` function is used for input prompts. To use
30173020
Neovim's `vim.ui.input()` function, add this to config:
30183021

@@ -3031,6 +3034,30 @@ autocompletion for better experience. snacks.nvim
30313034
<https://github.com/folke/snacks.nvim> input module supports autocompletion.
30323035

30333036

3037+
Agenda *orgmode-Agenda*
3038+
3039+
Use this section to customize the styling of the Agenda preview floating window
3040+
(See |orgmode-org_agenda_preview| mapping). To see available options for the
3041+
preview window, check `:help vim.lsp.util.open_floating_preview.Opts`. Here's
3042+
an example how to configure it:
3043+
3044+
>lua
3045+
require('orgmode').setup({
3046+
ui = {
3047+
agenda = {
3048+
preview_window = {
3049+
wrap = false, -- This option is set by default
3050+
border = 'single'
3051+
}
3052+
}
3053+
}
3054+
})
3055+
<
3056+
3057+
📝 NOTE: This preview should be used only as read only view of the headline
3058+
and it's content. Modifying the file from the preview window is not supported.
3059+
3060+
30343061
==============================================================================
30353062
2. Troubleshooting *orgmode-troubleshooting*
30363063

0 commit comments

Comments
 (0)