foam-template/docs/features/link-reference-definitions.md

Link Reference Definitions

When you use [[wiki-links]], the foam-vscode extension will automatically generate Markdown Link Reference Definitions at the bottom of the file.

This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support [[wiki-links]] directly.

Example

The following example:

- [[graph-visualization]]

...generates the following link reference definitions to the bottom of the file:

[graph-visualization]: graph-visualization "Graph Visualization"

Configuration

You can use the foam.edit.linkReferenceDefinitions to configure the definitions (see [get-started-with-vscode]):

• withoutExtensions (default): this works better with certain web publishing tools (e.g. GitHub pages)
• withExtensions: this works better with standard markdown-based tools (e.g GitHub web UI)
• off: this disables the generation of definitions

After changing the setting in your workspace, you can run the Foam: Run Janitor (Experimental) command to convert all existing definitions.