makary/foam-template
Template
1
0
Fork 0
mirror of https://github.com/foambubble/foam-template.git synced 2025-07-26 03:48:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Compare commits

base: makary:e9cfb66d91b1a7245b6155e4f7a39dbe0c5e3059
Branches Tags
makary:main
makary:bot/foam-docs-sync
makary:autodetect-color-theme
makary:readme-issue-update
makary:feature/templates
makary:onboarding
...
compare: makary:0585ac535effcda0078c4088e01dd6c6ae61bbeb
Branches Tags
makary:main
makary:bot/foam-docs-sync
makary:autodetect-color-theme
makary:readme-issue-update
makary:feature/templates
makary:onboarding

1 commit
e9cfb66d91 ... 0585ac535e

Author SHA1 Message Date
riccardoferretti
0585ac535e Docs sync @ cdbb965 Update commands.md 2023-12-15 21:32:11 +00:00
1 changed files with 7 additions and 7 deletions
Show stats 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.
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.
- 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)
- 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
- 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
- `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.
- `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
- `variables`: Variables to use in the text or template
- `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
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: