mirror of
https://github.com/foambubble/foam-template.git
synced 2025-06-07 20:08:54 +00:00
Standardize on wikilink
(#39)
Not `wiki-link`, nor `wiki link` https://en.wikipedia.org/wiki/Help:Link#Wikilinks
This commit is contained in:
parent
719ed27be6
commit
7e197a98bd
6 changed files with 18 additions and 18 deletions
|
@ -32,7 +32,7 @@ A sample configuration object is provided below, you can provide as many or as l
|
||||||
```
|
```
|
||||||
|
|
||||||
- `note` defines the color for regular nodes
|
- `note` defines the color for regular nodes
|
||||||
- `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists (see [[wiki-links]] for more info).
|
- `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists (see [[wikilinks]] for more info).
|
||||||
- `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature`
|
- `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature`
|
||||||
- see [[note-properties]] for details
|
- see [[note-properties]] for details
|
||||||
- you can have as many types as you want
|
- you can have as many types as you want
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Link Reference Definitions
|
# Link Reference Definitions
|
||||||
|
|
||||||
When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file.
|
When you use `[[wikilinks]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can 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.
|
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 `[[wikilinks]]` directly.
|
||||||
|
|
||||||
This feature is disabled by default because you don't need it to navigate your workspace, it is useful for publishing and compatibility of your notes.
|
This feature is disabled by default because you don't need it to navigate your workspace, it is useful for publishing and compatibility of your notes.
|
||||||
|
|
||||||
|
|
|
@ -1,13 +0,0 @@
|
||||||
# Wiki Links
|
|
||||||
|
|
||||||
Wiki links are the internal links that connect the files in your knowledge base.
|
|
||||||
|
|
||||||
To create a wiki link use `[[` and type the name of another file in your repo, for example [[graph-visualization]]
|
|
||||||
|
|
||||||
You can also create a [[placeholder]].
|
|
||||||
A placeholder is a wiki link 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).
|
|
13
docs/features/wikilinks.md
Normal file
13
docs/features/wikilinks.md
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
# Wikilinks
|
||||||
|
|
||||||
|
Wikilinks are the internal links that connect the files in your knowledge base.
|
||||||
|
|
||||||
|
To create a wikilink use `[[` and type the name of another file in your repo, for example [[graph-visualization]]
|
||||||
|
|
||||||
|
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).
|
|
@ -33,7 +33,7 @@ Here is a high level overview of Markdown, for more information on the Markdown
|
||||||
|
|
||||||
This is a [link to google](https://www.google.com).
|
This is a [link to google](https://www.google.com).
|
||||||
|
|
||||||
This is a wiki link (aka internal link) to [[note-properties]].
|
This is a wikilink (aka internal link) to [[note-properties]].
|
||||||
|
|
||||||
Here is an image:
|
Here is an image:
|
||||||

|

|
||||||
|
|
|
@ -8,7 +8,7 @@ Let's go through this to set up your repo:
|
||||||
|
|
||||||
- [ ] if you are new with VS Code, see how to [[get-started-with-vscode]] and how to [[use-keyboard-shortcuts-for-editing]]
|
- [ ] if you are new with VS Code, see how to [[get-started-with-vscode]] and how to [[use-keyboard-shortcuts-for-editing]]
|
||||||
|
|
||||||
- [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wiki link. You can go back with `ctrl+-`. Here, go to your [[inbox]]
|
- [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wikilink. You can go back with `ctrl+-`. Here, go to your [[inbox]]
|
||||||
|
|
||||||
- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command. See [[graph-visualization]].
|
- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command. See [[graph-visualization]].
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue