plugins.mkdnflow.perspective.fallback
Specifies the backup perspective to take if priority isn’t possible (e.g. if it is
root
but no root directory is found).
first
(default): Links will be interpreted relative to the first-opened file (when the current instance of Neovim was started)current
: Links will be interpreted relative to the current fileroot
: Links will be interpreted relative to the root directory of the current notebook (requiresperspective.root_tell
to be specified)
Type: null or one of “first”, “current”, “root” or raw lua code
Default:
null
Plugin default: "first"
Declared by:
plugins.mkdnflow.perspective.nvimWdHeel
Specifies whether changes in perspective will result in corresponding changes to Neovim’s working directory.
true
: Changes in perspective will be reflected in the nvim working directory. (In other words, the working directory will “heel” to the plugin’s perspective.) This helps ensure (at least) that path completions (if using a completion plugin with support for paths) will be accurate and usable.false
(default): Neovim’s working directory will not be affected by Mkdnflow.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.mkdnflow.perspective.priority
Specifies the priority perspective to take when interpreting link paths
first
(default): Links will be interpreted relative to the first-opened file (when the current instance of Neovim was started)current
: Links will be interpreted relative to the current fileroot
: Links will be interpreted relative to the root directory of the current notebook (requiresperspective.root_tell
to be specified)
Type: null or one of “first”, “current”, “root” or raw lua code
Default:
null
Plugin default: "first"
Declared by:
plugins.mkdnflow.perspective.rootTell
<any file name>
: Any arbitrary filename by which the plugin can uniquely identify the root directory of the current notebook.- If
false
is used instead, the plugin will never search for a root directory, even ifperspective.priority
is set toroot
.
Type: null or value false (singular enum) or string
Default:
null
Plugin default: false
Declared by:
plugins.mkdnflow.perspective.update
Determines whether the plugin looks to determine if a followed link is in a different
notebook/wiki than before.
If it is, the perspective will be updated.
Requires rootTell
to be defined and priority
to be root
.
true
(default): Perspective will be updated when following a link to a file in a separate notebook/wiki (or navigating backwards to a file in another notebook/wiki).false
: Perspective will be not updated when following a link to a file in a separate notebook/wiki. Under the hood, links in the file in the separate notebook/wiki will be interpreted relative to the original notebook/wiki.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by: