makary/foam-template
Template
1
0
Fork 0
mirror of https://github.com/foambubble/foam-template.git synced 2025-06-07 20:08:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix linting issues in link-reference-definitions

Browse source
This commit is contained in:
Prashanth K S 2021-08-29 19:51:52 +05:30
parent 7c160743ba
commit 42f5d0774c
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/features/link-reference-definitions.md
View file

@ -9,10 +9,13 @@ This feature is disabled by default because you don't need it to navigate your w
## Example ## Example
The following example: The following example:
```md ```md
- [[graph-visualization]] - [[graph-visualization]]
``` ```
...generates the following link reference definitions to the bottom of the file: ...generates the following link reference definitions to the bottom of the file:
```md ```md
[graph-visualization]: graph-visualization "Graph Visualization" [graph-visualization]: graph-visualization "Graph Visualization"
``` ```
@ -20,9 +23,9 @@ The following example:
## Configuration ## Configuration
You can use the `foam.edit.linkReferenceDefinitions` to configure the definitions (see [[get-started-with-vscode]]): 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) - `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) - `withExtensions`: this works better with standard markdown-based tools (e.g GitHub web UI)
- `off`: this disables the generation of definitions - `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. After changing the setting in your workspace, you can run the `Foam: Run Janitor (Experimental)` command to convert all existing definitions.