Files
foam/docs/user/features/wikilinks.md
sn3akiwhizper 6b2dda4a71 Documentation updates and cleaning (#1108)
* fixing some unmatched links, daily-note path note, start graphviz/tags/properties clarification

fixed links that didn't actually link to their target, add discussion about creating daily-notes in path based off date, then clarifying notes about styling graph viz and tags while enhancing the note properties descriptions by describing how properties are described and which properties are custom, which are foam-specific, and which are foam-template-specific

* add filter view, default variables to graphviz, and viewing tags in graphviz

graphviz: discuss filter view, add all changeable variables to graph style example, tags: describe viewing tags in the graphviz

* add small note about learning yaml

* last push fixing up some todos

* making recommended changes from PR request
2022-11-22 22:09:04 +01:00

2.3 KiB

Wikilinks

Wikilinks are the internal links that connect the files in your knowledge base. (Also called [[MediaWiki]] links).

To create a wikilink, type [[ and then start typing the name of another note in your repo. Once the desired note is selected press the tab key to autocomplete it. For example: [graph-visualization].

Cmd + Click ( Ctrl + Click on Windows ) on wikilink to navigate to that note (F12 also works while your cursor is on the wikilink). If the file doesn't exist it will be created in your workspace based on your default [note-templates] settings.

Placeholders

You can also create a placeholder. A placeholder is a wikilink that doesn't have a target file and a link to a placeholder is styled differently so you can easily tell them apart. They can still be helpful to highlight connections.

Open the graph with Foam: Show Graph command, and look at the placeholder node.

Remember, with CTRL/CMD+click on a wikilink you can navigate to the note, or create it (if the link is a placeholder).

Support for sections

Foam supports autocompletion, navigation, embedding and diagnostics for note sections. Just use the standard wiki syntax of [[resource#Section Title]].

Markdown compatibility

The Foam for VSCode extension automatically generates [link-reference-definitions] at the bottom of the file to make wikilinks compatible with other Markdown tools and parsers.

Read more