diff --git a/docs/features/graph-visualization.md b/docs/features/graph-visualization.md index 85103ff..614a99d 100644 --- a/docs/features/graph-visualization.md +++ b/docs/features/graph-visualization.md @@ -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 -- `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` - see [[note-properties]] for details - you can have as many types as you want diff --git a/docs/features/link-reference-definitions.md b/docs/features/link-reference-definitions.md index 84a0ac5..fb2614f 100644 --- a/docs/features/link-reference-definitions.md +++ b/docs/features/link-reference-definitions.md @@ -1,8 +1,8 @@ # 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. diff --git a/docs/features/wiki-links.md b/docs/features/wiki-links.md deleted file mode 100644 index cfdba60..0000000 --- a/docs/features/wiki-links.md +++ /dev/null @@ -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). diff --git a/docs/features/wikilinks.md b/docs/features/wikilinks.md new file mode 100644 index 0000000..02adb70 --- /dev/null +++ b/docs/features/wikilinks.md @@ -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). diff --git a/docs/how-to/write-notes-in-foam.md b/docs/how-to/write-notes-in-foam.md index d111bab..afa0158 100644 --- a/docs/how-to/write-notes-in-foam.md +++ b/docs/how-to/write-notes-in-foam.md @@ -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 wiki link (aka internal link) to [[note-properties]]. +This is a wikilink (aka internal link) to [[note-properties]]. Here is an image: ![image](../../attachments/foam-icon.png) diff --git a/getting-started.md b/getting-started.md index c06581d..c7bee88 100644 --- a/getting-started.md +++ b/getting-started.md @@ -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]] -- [ ] 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]].