Document templates in-place (#32)

* Document templates in-place

* Improve template copy

Co-authored-by: Riccardo <code@riccardoferretti.com>

Co-authored-by: Jonathan <jonny@mondago.com>
Co-authored-by: Riccardo <code@riccardoferretti.com>
This commit is contained in:
ingalless 2021-02-23 19:50:37 +00:00 committed by GitHub
parent b24fa3fd5c
commit 462dd65663
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -0,0 +1,25 @@
# Foam Note Templates
Foam includes note templates!
This allows you to easily create notes that have similar structure without having to use copy/paste :)
Templates support the [VS Code's Snippet Syntax](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_snippet-syntax), which means you can:
- add variables to the newly created note
- add tabstop to automatically navigate to the key parts of the note, just like a form
Below you can see an example showing a todo list and a timestamp.
## Todo List
1. ${1:First tabstop}
2. ${2:A second tabstop}
3. ${3:A third tabstop}
Note Created: ${CURRENT_YEAR}${CURRENT_MONTH}${CURRENT_DATE}
---
Try out the above example by running the `Foam: Create New Note From Template` command and selecting the `your-first-template` template. Notice what happens when your new note is created!
To remove this template, simply delete the `.foam/templates/your-first-template.md` file.
Enjoy!