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

Compare commits

base: makary:f6c0bcd6ce5235d1a691d55fa6121d6bdb9fc620
Branches Tags
makary:main
makary:bot/foam-docs-sync
makary:autodetect-color-theme
makary:readme-issue-update
makary:feature/templates
makary:onboarding
..
compare: makary:918b4188a047deb1fb1ac072fd456a5dd95d3423
Branches Tags
makary:main
makary:bot/foam-docs-sync
makary:autodetect-color-theme
makary:readme-issue-update
makary:feature/templates
makary:onboarding

2 commits
f6c0bcd6ce ... 918b4188a0

Author SHA1 Message Date
Fernando
918b4188a0
Merge 17c882c026 into d82820575d 2023-12-17 19:12:46 +00:00
Riccardo
d82820575d
Docs sync @ cdbb965 Update commands.md (#57) 2023-12-15 22:33:23 +01: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

@ -13,13 +13,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: