Link reference definitions make your notes compatible with standard Markdown processors by converting wikilinks to standard Markdown references.
Foam doesn’t need references in order to work, but this feature is aimed at supporting other tools you might want to integrate with.
Foam can automatically add reference definitions to the bottom of your notes:
Your note:
# Machine Learning
Related to [[Data Science]] and [[Statistics]].
With reference definitions:
# Machine Learning
Related to [[Data Science]] and [[Statistics]].
[//begin]: # 'Autogenerated link references for markdown compatibility'
[Data Science]: data-science.md 'Data Science'
[Statistics]: statistics.md 'Statistics'
[//end]: # 'Autogenerated link references'
Configure in your settings:
{
"foam.edit.linkReferenceDefinitions": "withExtensions"
}
Options:
"off"
- Disabled (default)"withoutExtensions"
- References without extension"withExtensions"
- References with extensionIf you are using your notes only within Foam, you can keep definitions off
(also to reduce clutter), otherwise pick your setting based on what is required by your use case.