Skip to content

Commit 42271b9

Browse files
alex-courtisalex-courtis
committed
docs(#2934): fix broken links
1 parent 9c33329 commit 42271b9

File tree

8 files changed

+63
-70
lines changed

8 files changed

+63
-70
lines changed

‎doc/nvim-tree-lua.txt‎

Lines changed: 38 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3468,15 +3468,13 @@ Class: Config *nvim-tree-config*
34683468
reinstate this one when formatting is done
34693469
#2934 --@field
34703470
hijack_unnamed_buffer_when_opening? boolean
3471-
• {root_dirs}? (`string[]`) Preferred root directories. Only
3472-
relevant when
3473-
|nvim_tree.Config.UpdateFocusedFile|
3474-
{update_root} is `true`
3471+
• {root_dirs}? (`string[]`) Preferred root directories.
3472+
Requires
3473+
|nvim_tree.Config.UpdateFocusedFile.UpdateRoot|.
34753474
• {prefer_startup_root}? (`boolean`, default: `false`) Prefer startup
34763475
root directory when updating root directory
3477-
of the tree. Only relevant when
3478-
|nvim_tree.Config.UpdateFocusedFile|
3479-
{update_root} is `true`
3476+
of the tree. Requires
3477+
|nvim_tree.Config.UpdateFocusedFile.UpdateRoot|.
34803478
• {sync_root_with_cwd}? (`boolean`, default: `false`) Changes the
34813479
tree root directory on |DirChanged| and
34823480
refreshes the tree.
@@ -3713,21 +3711,19 @@ Class: Config.Renderer *nvim-tree-config-renderer*
37133711
|nvim-tree-decorators|.
37143712
• {highlight_git}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37153713
Git status: `NvimTreeGit*HL`. Requires
3716-
|nvim_tree.Config.Git| {enable}.
3714+
|nvim_tree.Config.Git|.
37173715
• {highlight_opened_files}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37183716
|bufloaded()| files: `NvimTreeOpenedHL`.
37193717
• {highlight_hidden}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37203718
Hidden (dotfiles): `NvimTreeHiddenFileHL`.
37213719
• {highlight_modified}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37223720
Modified files: `NvimTreeModifiedFile`.
3723-
Requires |nvim_tree.Config.Modified|
3724-
{enable}.
3721+
Requires |nvim_tree.Config.Modified|.
37253722
• {highlight_bookmarks}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37263723
Bookmarked: `NvimTreeBookmarkHL`.
37273724
• {highlight_diagnostics}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `none`)
37283725
Diagnostic status: `NvimTreeDiagnostic*HL`.
3729-
Requires |nvim_tree.Config.Diagnostics|
3730-
{enable}.
3726+
Requires |nvim_tree.Config.Diagnostics|.
37313727
• {highlight_clipboard}? (`nvim_tree.Config.Renderer.HighlightPlacement`, default: `name`)
37323728
Copied: `NvimTreeCopiedHL`, cut:
37333729
`NvimTreeCutHL`.
@@ -3755,11 +3751,9 @@ Class: Config.Renderer *nvim-tree-config-renderer*
37553751
• {git_placement}? (`nvim_tree.Config.Renderer.Icons.Placement`)
37563752
(default: `before`)
37573753
• {diagnostics_placement}? (`nvim_tree.Config.Renderer.Icons.Placement`, default: `signcolumn`)
3758-
Requires |nvim_tree.Config.Diagnostics|
3759-
{enable}.
3754+
Requires |nvim_tree.Config.Diagnostics|.
37603755
• {modified_placement}? (`nvim_tree.Config.Renderer.Icons.Placement`, default: `after`)
3761-
Requires |nvim_tree.Config.Modified|
3762-
{enable}.
3756+
Requires |nvim_tree.Config.Modified|.
37633757
• {hidden_placement}? (`nvim_tree.Config.Renderer.Icons.Placement`)
37643758
(default: `after`)
37653759
• {bookmarks_placement}? (`nvim_tree.Config.Renderer.Icons.Placement`)
@@ -3787,13 +3781,13 @@ Class: Config.Renderer *nvim-tree-config-renderer*
37873781

37883782
Fields: ~
37893783
• {default}? (`string`, default: `` ) Files, overridden by
3790-
|nvim_tree.Config.Renderer.Icons| {web_devicons}
3784+
|nvim_tree.Config.Renderer.Icons.WebDevicons|.
37913785
• {symlink}? (`string`) (default: `` )
37923786
• {bookmark}? (`string`) (default: `󰆤` )
37933787
• {modified}? (`string`) (default: `●` )
37943788
• {hidden}? (`string`) (default: `󰜌` )
3795-
• {folder}? (`table`) Overridden by |nvim_tree.Config.Renderer.Icons|
3796-
{web_devicons} *nvim_tree.Config.Renderer.Icons.Glyphs.Folder*
3789+
• {folder}? (`table`) Overridden by
3790+
|nvim_tree.Config.Renderer.Icons.WebDevicons|. *nvim_tree.Config.Renderer.Icons.Glyphs.Folder*
37973791
• {arrow_closed}? (`string`) (default: left arrow)
37983792
• {arrow_open}? (`string`) (default: down arrow)
37993793
• {default}? (`string`) (default: `` )
@@ -3829,24 +3823,23 @@ Class: Config.Renderer *nvim-tree-config-renderer*
38293823
• {folder}? (`boolean`, default: `true`) Before folder name.
38303824
• {folder_arrow}? (`boolean`, default: `true`) Show a small arrow
38313825
before the folder node. Arrow will be a part of the
3832-
node when using |nvim_tree.Config.Renderer|
3833-
{indent_markers}.
3834-
• {git}? (`boolean`, default: `true`) Icons:
3835-
|nvim_tree.Config.Renderer.Icons.Glyphs.Git|.
3836-
Location: |nvim_tree.Config.Renderer.Icons|
3837-
{git_placement}. Requires |nvim_tree.Config.Git|
3838-
{enable}.
3826+
node when using
3827+
|nvim_tree.Config.Renderer.IndentMarkers|.
3828+
• {git}? (`boolean`, default: `true`) Location:
3829+
|nvim_tree.Config.Renderer.Icons| {git_placement}.
3830+
Icons: |nvim_tree.Config.Renderer.Icons.Glyphs.Git|.
3831+
Requires |nvim_tree.Config.Git|.
38393832
• {modified}? (`boolean`, default: `true`) Location:
38403833
|nvim_tree.Config.Renderer.Icons|
38413834
{modified_placement}. Requires
3842-
|nvim_tree.Config.Modified| {enable}.
3835+
|nvim_tree.Config.Modified|.
38433836
• {hidden}? (`boolean`, default: `false`) Location:
38443837
|nvim_tree.Config.Renderer.Icons| {hidden_placement}.
3845-
• {diagnostics}? (`boolean`, default: `true`) Icons:
3846-
|nvim_tree.Config.Diagnostics.Icons| Location:
3838+
• {diagnostics}? (`boolean`, default: `true`) Location:
38473839
|nvim_tree.Config.Renderer.Icons|
3848-
{diagnostics_placement}. Requires
3849-
|nvim_tree.Config.Diagnostics| {enable}.
3840+
{diagnostics_placement}. Icons:
3841+
|nvim_tree.Config.Diagnostics.Icons|. Requires
3842+
|nvim_tree.Config.Diagnostics|.
38503843
• {bookmarks}? (`boolean`, default: `true`) Location:
38513844
|nvim_tree.Config.Renderer.Icons|
38523845
{bookmarks_placement}.
@@ -3860,15 +3853,15 @@ Class: Config.Renderer *nvim-tree-config-renderer*
38603853
• {file}? (`table`)
38613854
*nvim_tree.Config.Renderer.Icons.WebDevicons.File*
38623855
• {enable}? (`boolean`, default: `true`) Show icons for
3863-
files, overrides |nvim_tree.Config.Renderer.Icons.Glyphs|
3864-
{default}.
3856+
files, overrides
3857+
|nvim_tree.Config.Renderer.Icons.Glyphs.Git|.
38653858
• {color}? (`boolean`, default: `true`) Apply colours to
38663859
files, overrides `NvimTreeFileIcon`.
38673860
• {folder}? (`table`)
38683861
*nvim_tree.Config.Renderer.Icons.WebDevicons.Folder*
38693862
• {enable}? (`boolean`, default: `false`) Show icons for
38703863
directories, overrides
3871-
|nvim_tree.Config.Renderer.Icons.Glyphs| {folder}.
3864+
|nvim_tree.Config.Renderer.Icons.Glyphs.Folder|.
38723865
• {color}? (`boolean`, default: `true`) Apply colors to
38733866
directories, overrides `NvimTree*FolderName`.
38743867

@@ -3931,7 +3924,7 @@ Class: Config.UpdateFocusedFile *nvim-tree-config-update-focused-file*
39313924
Prefers vim's cwd and |nvim_tree.Config| {root_dirs}, falling back to the
39323925
directory containing the file.
39333926

3934-
Only relevant when |nvim_tree.Config.UpdateFocusedFile| {enable} is `true`
3927+
Requires |nvim_tree.Config.UpdateFocusedFile|
39353928

39363929
Fields: ~
39373930
• {enable}? (`boolean`) (default: `false`)
@@ -3988,8 +3981,8 @@ Class: Config.Git *nvim-tree-config-git*
39883981
of children when directory itself has no status
39893982
icon
39903983
• {show_on_open_dirs}? (`boolean`, default: `true`) Show status icons
3991-
of children on directories that are open. Only
3992-
relevant when {show_on_dirs} is `true`.
3984+
of children on directories that are open.
3985+
Requires {show_on_dirs}.
39933986
• {disable_for_dirs}? (`string[]|(fun(path: string): boolean)`,
39943987
default: `{}`) Disable for top level paths.
39953988
• {timeout}? (`integer`, default: `400`) `git` processes
@@ -4012,8 +4005,8 @@ Class: Config.Diagnostics *nvim-tree-config-diagnostics*
40124005
• {show_on_dirs}? (`boolean`, default: `false`) Show diagnostic
40134006
icons on parent directories.
40144007
• {show_on_open_dirs}? (`boolean`, default: `true`) Show diagnostics
4015-
icons on directories that are open. Only
4016-
relevant when {show_on_dirs} is `true`.
4008+
icons on directories that are open. Requires
4009+
{show_on_dirs}.
40174010
• {diagnostic_opts}? (`boolean`, default: `false`) Global
40184011
|vim.diagnostic.Opts| overrides {severity} and
40194012
{icons}
@@ -4036,18 +4029,18 @@ Class: Config.Modified *nvim-tree-config-modified*
40364029

40374030
*nvim_tree.Config.Modified*
40384031
Indicate which files have unsaved modification. To see modified status in
4039-
the tree you will need to set:
4040-
• |nvim_tree.Config.Renderer.Icons.Show| {modified} to `true` OR
4041-
• |nvim_tree.Config.Renderer| {highlight_modified} to `true`
4032+
the tree you will need:
4033+
• |nvim_tree.Config.Renderer.Icons.Show| {modified} OR
4034+
• |nvim_tree.Config.Renderer| {highlight_modified}
40424035

40434036
Fields: ~
40444037
• {enable}? (`boolean`) (default: `false`)
40454038
• {show_on_dirs}? (`boolean`, default: `true`) Show modified
40464039
indication on directory whose children are
40474040
modified.
40484041
• {show_on_open_dirs}? (`boolean`, default: `false`) Show modified
4049-
indication on open directories. Only relevant
4050-
when {show_on_dirs} is `true`.
4042+
indication on open directories. Requires
4043+
{show_on_dirs}.
40514044

40524045

40534046

@@ -4063,7 +4056,7 @@ Filters can be set at startup and toggled live via API with default keymappings.
40634056

40644057
`I` {git_ignored} |nvim-tree-api.tree.toggle_gitignore_filter()|
40654058
Ignore files based on `.gitignore`.
4066-
Requires |nvim_tree.Config.Git| {enable}
4059+
Requires |nvim_tree.Config.Git|
40674060

40684061
`H` {dotfiles} |nvim-tree-api.tree.toggle_hidden_filter()|
40694062
Filter dotfiles: files starting with a `.`

‎lua/nvim-tree/_meta/config.lua‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ error("Cannot require a meta file")
3131
-----@field hijack_unnamed_buffer_when_opening? boolean
3232
---@field hubwo? boolean
3333
---
34-
---Preferred root directories. Only relevant when [nvim_tree.Config.UpdateFocusedFile] {update_root} is `true`
34+
---Preferred root directories. Requires [nvim_tree.Config.UpdateFocusedFile.UpdateRoot].
3535
---@field root_dirs? string[]
3636
---
37-
---Prefer startup root directory when updating root directory of the tree. Only relevant when [nvim_tree.Config.UpdateFocusedFile] {update_root} is `true`
37+
---Prefer startup root directory when updating root directory of the tree. Requires [nvim_tree.Config.UpdateFocusedFile.UpdateRoot].
3838
---(default: `false`)
3939
---@field prefer_startup_root? boolean
4040
---

‎lua/nvim-tree/_meta/config/diagnostics.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ error("Cannot require a meta file")
1616
---(default: `false`)
1717
---@field show_on_dirs? boolean
1818
---
19-
---Show diagnostics icons on directories that are open. Only relevant when {show_on_dirs} is `true`.
19+
---Show diagnostics icons on directories that are open. Requires {show_on_dirs}.
2020
---(default: `true`)
2121
---@field show_on_open_dirs? boolean
2222
---

‎lua/nvim-tree/_meta/config/filters.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ error("Cannot require a meta file")
1111
---
1212
---`I` {git_ignored} |nvim-tree-api.tree.toggle_gitignore_filter()|
1313
--- Ignore files based on `.gitignore`.
14-
--- Requires |nvim_tree.Config.Git| {enable}
14+
--- Requires |nvim_tree.Config.Git|
1515
---
1616
---`H` {dotfiles} |nvim-tree-api.tree.toggle_hidden_filter()|
1717
--- Filter dotfiles: files starting with a `.`

‎lua/nvim-tree/_meta/config/git.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ error("Cannot require a meta file")
1818
---(default: `true`)
1919
---@field show_on_dirs? boolean
2020
---
21-
---Show status icons of children on directories that are open. Only relevant when {show_on_dirs} is `true`.
21+
---Show status icons of children on directories that are open. Requires {show_on_dirs}.
2222
---(default: `true`)
2323
---@field show_on_open_dirs? boolean
2424
---

‎lua/nvim-tree/_meta/config/modified.lua‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
error("Cannot require a meta file")
33

44
---Indicate which files have unsaved modification.
5-
---To see modified status in the tree you will need to set:
6-
--- - [nvim_tree.Config.Renderer.Icons.Show] {modified} to `true` OR
7-
--- - [nvim_tree.Config.Renderer] {highlight_modified} to `true`
5+
---To see modified status in the tree you will need:
6+
--- - [nvim_tree.Config.Renderer.Icons.Show] {modified} OR
7+
--- - [nvim_tree.Config.Renderer] {highlight_modified}
88
---@class nvim_tree.Config.Modified
99
---
1010
---(default: `false`)
@@ -14,6 +14,6 @@ error("Cannot require a meta file")
1414
---(default: `true`)
1515
---@field show_on_dirs? boolean
1616
---
17-
---Show modified indication on open directories. Only relevant when {show_on_dirs} is `true`.
17+
---Show modified indication on open directories. Requires {show_on_dirs}.
1818
---(default: `false`)
1919
---@field show_on_open_dirs? boolean

‎lua/nvim-tree/_meta/config/renderer.lua‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ error("Cannot require a meta file")
6363
---@field decorators? (string|nvim_tree.api.decorator.UserDecorator)[]
6464
---
6565
---Git status: `NvimTreeGit*HL`.
66-
---Requires [nvim_tree.Config.Git] {enable}.
66+
---Requires [nvim_tree.Config.Git].
6767
---(default: `none`)
6868
---@field highlight_git? nvim_tree.Config.Renderer.HighlightPlacement
6969
---
@@ -76,7 +76,7 @@ error("Cannot require a meta file")
7676
---@field highlight_hidden? nvim_tree.Config.Renderer.HighlightPlacement
7777
---
7878
---Modified files: `NvimTreeModifiedFile`.
79-
---Requires [nvim_tree.Config.Modified] {enable}.
79+
---Requires [nvim_tree.Config.Modified].
8080
---(default: `none`)
8181
---@field highlight_modified? nvim_tree.Config.Renderer.HighlightPlacement
8282
---
@@ -85,7 +85,7 @@ error("Cannot require a meta file")
8585
---@field highlight_bookmarks? nvim_tree.Config.Renderer.HighlightPlacement
8686
---
8787
---Diagnostic status: `NvimTreeDiagnostic*HL`.
88-
---Requires [nvim_tree.Config.Diagnostics] {enable}.
88+
---Requires [nvim_tree.Config.Diagnostics].
8989
---(default: `none`)
9090
---@field highlight_diagnostics? nvim_tree.Config.Renderer.HighlightPlacement
9191
---
@@ -152,11 +152,11 @@ error("Cannot require a meta file")
152152
---(default: `before`)
153153
---@field git_placement? nvim_tree.Config.Renderer.Icons.Placement
154154
---
155-
---Requires [nvim_tree.Config.Diagnostics] {enable}.
155+
---Requires [nvim_tree.Config.Diagnostics].
156156
---(default: `signcolumn`)
157157
---@field diagnostics_placement? nvim_tree.Config.Renderer.Icons.Placement
158158
---
159-
---Requires [nvim_tree.Config.Modified] {enable}.
159+
---Requires [nvim_tree.Config.Modified].
160160
---(default: `after`)
161161
---@field modified_placement? nvim_tree.Config.Renderer.Icons.Placement
162162
---
@@ -194,7 +194,7 @@ error("Cannot require a meta file")
194194
---@class nvim_tree.Config.Renderer.Icons.WebDevicons.File
195195
---@inlinedoc
196196
---
197-
---Show icons for files, overrides [nvim_tree.Config.Renderer.Icons.Glyphs] {default}.
197+
---Show icons for files, overrides [nvim_tree.Config.Renderer.Icons.Glyphs.Git].
198198
---(default: `true`)
199199
---@field enable? boolean
200200
---
@@ -207,7 +207,7 @@ error("Cannot require a meta file")
207207
---@class nvim_tree.Config.Renderer.Icons.WebDevicons.Folder
208208
---@inlinedoc
209209
---
210-
---Show icons for directories, overrides [nvim_tree.Config.Renderer.Icons.Glyphs] {folder}.
210+
---Show icons for directories, overrides [nvim_tree.Config.Renderer.Icons.Glyphs.Folder].
211211
---(default: `false`)
212212
---@field enable? boolean
213213
---
@@ -250,28 +250,28 @@ error("Cannot require a meta file")
250250
---(default: `true`)
251251
---@field folder? boolean
252252
---
253-
---Show a small arrow before the folder node. Arrow will be a part of the node when using [nvim_tree.Config.Renderer] {indent_markers}.
253+
---Show a small arrow before the folder node. Arrow will be a part of the node when using [nvim_tree.Config.Renderer.IndentMarkers].
254254
---(default: `true`)
255255
---@field folder_arrow? boolean
256256
---
257-
---Icons: [nvim_tree.Config.Renderer.Icons.Glyphs.Git].
258257
---Location: [nvim_tree.Config.Renderer.Icons] {git_placement}.
259-
---Requires [nvim_tree.Config.Git] {enable}.
258+
---Icons: [nvim_tree.Config.Renderer.Icons.Glyphs.Git].
259+
---Requires [nvim_tree.Config.Git].
260260
---(default: `true`)
261261
---@field git? boolean
262262
---
263263
---Location: [nvim_tree.Config.Renderer.Icons] {modified_placement}.
264-
---Requires [nvim_tree.Config.Modified] {enable}.
264+
---Requires [nvim_tree.Config.Modified].
265265
---(default: `true`)
266266
---@field modified? boolean
267267
---
268268
---Location: [nvim_tree.Config.Renderer.Icons] {hidden_placement}.
269269
---(default: `false`)
270270
---@field hidden? boolean
271271
---
272-
---Icons: [nvim_tree.Config.Diagnostics.Icons]
273272
---Location: [nvim_tree.Config.Renderer.Icons] {diagnostics_placement}.
274-
---Requires [nvim_tree.Config.Diagnostics] {enable}.
273+
---Icons: [nvim_tree.Config.Diagnostics.Icons].
274+
---Requires [nvim_tree.Config.Diagnostics].
275275
---(default: `true`)
276276
---@field diagnostics? boolean
277277
---
@@ -287,7 +287,7 @@ error("Cannot require a meta file")
287287
---- [nvim_tree.Config.Renderer.IndentMarkers.Icons]
288288
---@class nvim_tree.Config.Renderer.Icons.Glyphs
289289
---
290-
---Files, overridden by [nvim_tree.Config.Renderer.Icons] {web_devicons}
290+
---Files, overridden by [nvim_tree.Config.Renderer.Icons.WebDevicons].
291291
---(default: `` )
292292
---@field default? string
293293
---
@@ -303,7 +303,7 @@ error("Cannot require a meta file")
303303
---(default: `󰜌` )
304304
---@field hidden? string
305305
---
306-
---Overridden by [nvim_tree.Config.Renderer.Icons] {web_devicons}
306+
---Overridden by [nvim_tree.Config.Renderer.Icons.WebDevicons].
307307
---@field folder? nvim_tree.Config.Renderer.Icons.Glyphs.Folder
308308
---
309309
---Git status on files and directories.

‎lua/nvim-tree/_meta/config/update_focused_file.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ error("Cannot require a meta file")
2020
---
2121
---Prefers vim's cwd and [nvim_tree.Config] {root_dirs}, falling back to the directory containing the file.
2222
---
23-
---Only relevant when [nvim_tree.Config.UpdateFocusedFile] {enable} is `true`
23+
---Requires [nvim_tree.Config.UpdateFocusedFile]
2424
---
2525
---@class nvim_tree.Config.UpdateFocusedFile.UpdateRoot
2626
---

0 commit comments

Comments
 (0)