documentation: new notes
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
*denote.txt* For Vim version 9.0. Last change: 2026 Feb 17
|
||||
*denote.txt* For Vim version 9.0. Last change: 2026 Feb 18
|
||||
|
||||
This is the documentation for the denote plugin.
|
||||
|
||||
@@ -51,25 +51,47 @@ This command is a wrapper around |:lvimgrep| to search for a pattern in the
|
||||
denote entries. The required argument is a pattern as required by |:vimgrep|,
|
||||
i.e., /{pattern}/[g][j][f].
|
||||
|
||||
*:DenoteNew*
|
||||
This command takes as argument a note title, and generates a new denote entry
|
||||
with the specified title. The entry file type is controlled by the setting
|
||||
|g:denote_new_ft|.
|
||||
|
||||
*:DenoteBackReferences*
|
||||
When called from an opened denote entry, this command populates the location
|
||||
list with all references to the current note.
|
||||
|
||||
*denote-settings*
|
||||
Settings ~
|
||||
*'g:denote_note_file_extension'*
|
||||
*g:denote_note_file_extension*
|
||||
With this setting you may specify the file extensions of all denote entries
|
||||
within which |:DenoteGrep| will search for the provided pattern. If left
|
||||
unspecified, it is set to the following default value:
|
||||
>
|
||||
g:denote_note_file_extension = ['md', 'org', 'txt']
|
||||
<
|
||||
*'g:denote_loc_title_columns'*
|
||||
*g:denote_loc_title_columns*
|
||||
This integer specifies the number of columns used to display the titles of
|
||||
denote entries. Per default, it is set to:
|
||||
>
|
||||
g:denote_loc_title_columns = 60
|
||||
<
|
||||
*g:denote_new_ft*
|
||||
Newly created notes are of this file type. Possible values are 'md', 'org', or
|
||||
'txt', with the following default:
|
||||
>
|
||||
g:denote_new_ft = 'md'
|
||||
<
|
||||
*g:denote_fm_md_type*
|
||||
The front matter of 'md' notes is given as 'yaml' or as 'toml'. By default,
|
||||
this package uses 'yaml':
|
||||
>
|
||||
g:denote_fm_md_type = 'yaml'
|
||||
<
|
||||
*g:denote_identifier_fun*
|
||||
Denote allows the use of custom identifiers. This variable, if set, points to
|
||||
a function that generates identifiers for newly created notes. The function is
|
||||
supposed to return a unique string.
|
||||
|
||||
*denote-mappings*
|
||||
Mappings ~
|
||||
|
||||
|
||||
Reference in New Issue
Block a user