From 42f5d0774cee7d7472366ed1283b056a023450c0 Mon Sep 17 00:00:00 2001 From: Prashanth K S Date: Sun, 29 Aug 2021 19:51:52 +0530 Subject: [PATCH] Fix linting issues in link-reference-definitions --- docs/features/link-reference-definitions.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/features/link-reference-definitions.md b/docs/features/link-reference-definitions.md index 57a454b..5ec9c1f 100644 --- a/docs/features/link-reference-definitions.md +++ b/docs/features/link-reference-definitions.md @@ -9,10 +9,13 @@ This feature is disabled by default because you don't need it to navigate your w ## 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" ``` @@ -20,9 +23,9 @@ The following example: ## 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. -