makary/foam-template
Template
1
0
Fork 0
mirror of https://github.com/foambubble/foam-template.git synced 2025-06-07 20:08:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs sync @ cdbb965 Update commands.md (#57)

Browse source
This commit is contained in:
Riccardo 2023-12-15 22:33:23 +01:00 • committed by GitHub
parent b90eb07935
commit d82820575d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/features/commands.md
View file

@ -10,13 +10,13 @@ This command creates a note.
Although it works fine on its own, it can be customized to achieve various use cases. Although it works fine on its own, it can be customized to achieve various use cases.
Here are the settings available for the command: Here are the settings available for the command:
- notePath: The path of the note to create. If relative it will be resolved against the workspace root. - `notePath`: The path of the note to create. If relative it will be resolved against the workspace root.
- templatePath: The path of the template to use. If relative it will be resolved against the workspace root. - `templatePath`: The path of the template to use. If relative it will be resolved against the workspace root.
- title: The title of the note (that is, the `FOAM_TITLE` variable) - `title`: The title of the note (that is, the `FOAM_TITLE` variable)
- text: The text to use for the note. If also a template is provided, the template has precedence - `text`: The text to use for the note. If also a template is provided, the template has precedence
- variables: Variables to use in the text or template - `variables`: Variables to use in the text or template
- date: The date used to resolve the FOAM*DATE*\* variables. in `YYYY-MM-DD` format - `date`: The date used to resolve the FOAM*DATE*\* variables. in `YYYY-MM-DD` format
- onFileExists?: 'overwrite' | 'open' | 'ask' | 'cancel': What to do in case the target file already exists - `onFileExists?: 'overwrite' | 'open' | 'ask' | 'cancel'`: What to do in case the target file already exists
To customize a command and associate a key binding to it, open the key binding settings and add the appropriate configuration, here are some examples: To customize a command and associate a key binding to it, open the key binding settings and add the appropriate configuration, here are some examples: