mirror of
https://github.com/foambubble/foam.git
synced 2026-04-24 03:01:01 -04:00
a23e73245f
* changed vscode setting to include extensions in link definition * updated docs to include extension in wikilink definition * updated readme to navigate to github pages instead of published site
2.1 KiB
2.1 KiB
Wiki Links
Foam enables you to Link pages together using [[file-name]] annotations (i.e. [[media-wiki]] links).
- Type
[[and start typing a file name for autocompletion.- Note that your file names should be in
lower-dash-case.md, and your wiki links should reference file names exactly:[[lower-dash-case]], not[[Lower Dash Case]]. - See [link-formatting-and-autocompletion] for more information, and how to setup your link autocompletions to make this easier.
- Note that your file names should be in
Cmd+Click(Ctrl+Clickon Windows ) on file name to navigate to file (F12also works while your cursor is on the file name)Cmd+Click(Ctrl+Clickon Windows ) on non-existent file to create that file in the workspace.
If the
F12shortcut feels unnatural you can rebind it at File > Preferences > Keyboard Shortcuts by searching foreditor.action.revealDefinition.
Required extensions
- Markdown Notes (core functionality)
- Foam for VSCode (for Markdown compatibility)
Markdown compatibility
The Foam for VSCode extension automatically generates [link-reference-definitions] at the bottom of the file to make wiki-links compatible with Markdown tools and parsers.
Read more
- [foam-file-format]
- [link-formatting-and-autocompletion]
- See [link-reference-definition-improvements] for further discussion on current problems and potential solutions.