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

Compare commits

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

2 commits
0585ac535e ... e9cfb66d91

Author SHA1 Message Date
riccardoferretti
e9cfb66d91 Docs sync @ e4f6259 Update recipes.md (#1341) 2024-03-10 14:18:53 +00:00
Riccardo
d82820575d
Docs sync @ cdbb965 Update commands.md (#57) 2023-12-15 22:33:23 +01:00
2 changed files with 8 additions and 8 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. 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:

2
docs/recipes/recipes.md
View file

@ -75,7 +75,7 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work
- Publish using community templates - Publish using community templates
- [[publish-to-netlify-with-eleventy]] by [@juanfrank77](https://github.com/juanfrank77) - [[publish-to-netlify-with-eleventy]] by [@juanfrank77](https://github.com/juanfrank77)
- [[generate-gatsby-site]] by [@mathieudutour](https://github.com/mathieudutour) and [@hikerpig](https://github.com/hikerpig) - [[generate-gatsby-site]] by [@mathieudutour](https://github.com/mathieudutour) and [@hikerpig](https://github.com/hikerpig)
- [foamy-nextjs](https://github.com/yenly/foamy-nextjs) by [@yenly](https://github.com/yenly)
- Make the site your own by [[publish-to-github]]. - Make the site your own by [[publish-to-github]].
- Render math symbols, by either - Render math symbols, by either
- adding client-side [[math-support-with-mathjax]] to the default [[publish-to-github-pages]] site - adding client-side [[math-support-with-mathjax]] to the default [[publish-to-github-pages]] site