mirror of
https://github.com/foambubble/foam-template.git
synced 2025-06-07 20:08:54 +00:00
d9028e82fb
* removed gitlens * adjusted various settings * added foam onboarding to template * removed prettier extension * added setting to match OS color scheme * a couple of minor changes re todos and readme * added spellright to list of recommended extensions, and added to getting started guide * added reference to LTeX in spell checking doc * Added logo to readme * fixed link to LTeX extension * styling logo in readme * more style experiments
30 lines
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
# Link Reference Definitions
|
|
|
|
When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#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:
|
|
```md
|
|
- [[graph-visualization]]
|
|
```
|
|
...generates the following link reference definitions to the bottom of the file:
|
|
```md
|
|
[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.
|
|
|
|
|
|
[//begin]: # "Autogenerated link references for markdown compatibility"
|
|
[get-started-with-vscode]: ../how-to/get-started-with-vscode.md "Getting started with VsCode"
|
|
[//end]: # "Autogenerated link references"
|