From ec2d44ad86e3df962008361a07ba2501a5943515 Mon Sep 17 00:00:00 2001 From: Riccardo Ferretti Date: Mon, 22 Mar 2021 17:05:46 +0100 Subject: [PATCH] updated template to default settings for Foam 0.12.0 --- .vscode/settings.json | 2 +- docs/features/daily-notes.md | 4 +--- docs/features/graph-visualization.md | 5 ----- docs/features/link-reference-definitions.md | 8 +++----- docs/features/note-properties.md | 6 ------ docs/features/tags-and-tag-explorer.md | 3 --- docs/features/wiki-links.md | 7 +++---- docs/how-to/get-started-with-vscode.md | 3 --- docs/how-to/write-notes-in-foam.md | 5 ----- getting-started.md | 13 ------------- inbox.md | 3 --- 11 files changed, 8 insertions(+), 51 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 9139a42..9709fc7 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,7 +13,7 @@ "files.watcherExclude": { "**/node_modules": true }, - "foam.edit.linkReferenceDefinitions": "withExtensions", + "foam.edit.linkReferenceDefinitions": "off", "foam.openDailyNote.directory": "journal", "foam.openDailyNote.titleFormat": "fullDate", "git.enableSmartCommit": true, diff --git a/docs/features/daily-notes.md b/docs/features/daily-notes.md index f95c199..6635b7b 100644 --- a/docs/features/daily-notes.md +++ b/docs/features/daily-notes.md @@ -7,6 +7,7 @@ Try it out, run the `Foam: Open Daily Note` command. ## Shortcuts and Snippets You can quickly open today's daily note by pressing `alt+d`. +You can also automatically open today's note via the `Foam › Open Daily Note: On Startup` setting. You can also quickly create link to your daily notes, in the configured format, using [snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets). @@ -39,6 +40,3 @@ The following properties can be used: The above configuration would create a file `journal/daily-note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`. - - - diff --git a/docs/features/graph-visualization.md b/docs/features/graph-visualization.md index 8c937b0..dd5cfc0 100644 --- a/docs/features/graph-visualization.md +++ b/docs/features/graph-visualization.md @@ -36,8 +36,3 @@ A sample configuration object is provided below, you can provide as many or as l - see [[note-properties]] for details - you can have as many types as you want - -[//begin]: # "Autogenerated link references for markdown compatibility" -[wiki-links]: wiki-links.md "Wiki Links" -[note-properties]: note-properties.md "Note Properties" -[//end]: # "Autogenerated link references" diff --git a/docs/features/link-reference-definitions.md b/docs/features/link-reference-definitions.md index f555127..57a454b 100644 --- a/docs/features/link-reference-definitions.md +++ b/docs/features/link-reference-definitions.md @@ -1,9 +1,11 @@ # Link Reference Definitions -When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. +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. 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 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. + ## Example The following example: @@ -24,7 +26,3 @@ You can use the `foam.edit.linkReferenceDefinitions` to configure the definition After changing the setting in your workspace, you can run the `Foam: Run Janitor (Experimental)` command to convert all existing definitions. - -[//begin]: # "Autogenerated link references for markdown compatibility" -[get-started-with-vscode]: ../how-to/get-started-with-vscode.md "Getting started with VsCode" -[//end]: # "Autogenerated link references" diff --git a/docs/features/note-properties.md b/docs/features/note-properties.md index deb20ad..597f990 100644 --- a/docs/features/note-properties.md +++ b/docs/features/note-properties.md @@ -26,9 +26,3 @@ Some properties have special meaning for Foam: - the `type` property can be used to style notes differently in the graph (also see [[graph-visualization]]) - the `tags` property can be used to add tags to a note (see [[tags-and-tag-explorer]]) - -[//begin]: # "Autogenerated link references for markdown compatibility" -[write-notes-in-foam]: ../how-to/write-notes-in-foam.md "Writing Notes" -[graph-visualization]: graph-visualization.md "Graph Visualization" -[tags-and-tag-explorer]: tags-and-tag-explorer.md "Tags and Tag Explorer" -[//end]: # "Autogenerated link references" diff --git a/docs/features/tags-and-tag-explorer.md b/docs/features/tags-and-tag-explorer.md index bb8d696..661a2e2 100644 --- a/docs/features/tags-and-tag-explorer.md +++ b/docs/features/tags-and-tag-explorer.md @@ -19,6 +19,3 @@ You can use this panel to see the tags in your notes, and navigate them. Notice `my-tag1` and `my-tag2`, which were added via [[note-properties]]. -[//begin]: # "Autogenerated link references for markdown compatibility" -[note-properties]: note-properties.md "Note Properties" -[//end]: # "Autogenerated link references" diff --git a/docs/features/wiki-links.md b/docs/features/wiki-links.md index a33d45b..cfdba60 100644 --- a/docs/features/wiki-links.md +++ b/docs/features/wiki-links.md @@ -5,10 +5,9 @@ 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. +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. -[//begin]: # "Autogenerated link references for markdown compatibility" -[graph-visualization]: graph-visualization.md "Graph Visualization" -[//end]: # "Autogenerated link references" +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/get-started-with-vscode.md b/docs/how-to/get-started-with-vscode.md index 32ae1d9..3954b73 100644 --- a/docs/how-to/get-started-with-vscode.md +++ b/docs/how-to/get-started-with-vscode.md @@ -41,6 +41,3 @@ You can see a few panels on the left, including: To view or change the settings in VsCode, press `cmd+,` -[//begin]: # "Autogenerated link references for markdown compatibility" -[tags-and-tag-explorer]: ../features/tags-and-tag-explorer.md "Tags and Tag Explorer" -[//end]: # "Autogenerated link references" diff --git a/docs/how-to/write-notes-in-foam.md b/docs/how-to/write-notes-in-foam.md index 9bc59eb..acbb9ab 100644 --- a/docs/how-to/write-notes-in-foam.md +++ b/docs/how-to/write-notes-in-foam.md @@ -66,8 +66,3 @@ you can create code blocks ``` - -[//begin]: # "Autogenerated link references for markdown compatibility" -[note-properties]: ../features/note-properties.md "Note Properties" -[graph-visualization]: ../features/graph-visualization.md "Graph Visualization" -[//end]: # "Autogenerated link references" diff --git a/getting-started.md b/getting-started.md index a1e4f00..9182ce7 100644 --- a/getting-started.md +++ b/getting-started.md @@ -48,16 +48,3 @@ Here they are: A special mention goes to [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links), which has now been replaced by our graph but was foundational to Foam's beginnings. -[//begin]: # "Autogenerated link references for markdown compatibility" -[get-started-with-vscode]: docs/how-to/get-started-with-vscode.md "Getting started with VsCode" -[use-keyboard-shortcuts-for-editing]: docs/how-to/use-keyboard-shortcuts-for-editing.md "Use Keyboard Shortcuts for Editing" -[inbox]: inbox.md "Inbox" -[graph-visualization]: docs/features/graph-visualization.md "Graph Visualization" -[tags-and-tag-explorer]: docs/features/tags-and-tag-explorer.md "Tags and Tag Explorer" -[spell-checking]: docs/features/spell-checking.md "Spell Checking" -[paste-images-from-clipboard]: docs/how-to/paste-images-from-clipboard.md "Paste Images from Clipboard" -[daily-notes]: docs/features/daily-notes.md "Daily Notes" -[todo]: todo.md "Todo" -[link-reference-definitions]: docs/features/link-reference-definitions.md "Link Reference Definitions" -[note-templates]: docs/features/note-templates.md "Note Templates" -[//end]: # "Autogenerated link references" diff --git a/inbox.md b/inbox.md index 453685e..7231cf7 100644 --- a/inbox.md +++ b/inbox.md @@ -11,6 +11,3 @@ - That's ok, you can just delete them! - You can always find them in your git history, if you really need it! -[//begin]: # "Autogenerated link references for markdown compatibility" -[todo]: todo.md "Todo" -[//end]: # "Autogenerated link references"