Update template

.vscode/extensions.json

@@ -2,10 +2,26 @@
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
   "recommendations": [
+    // Foam's own extension
+    "foam.foam-vscode",
+
+    // Prettier for auto formatting code
     "esbenp.prettier-vscode",
+
+    // GitLens for seeing version history inline
     "eamodio.gitlens",
+
+    // Git Automator for quick commit and push
+    // (Could be improved)
     "ivangabriele.vscode-git-add-and-commit",
-    "philipbe.theme-gray-matter",
-    "yzhang.markdown-all-in-one"
+
+    // Tons of markdown goodies (lists, tables of content, so much more)
+    "yzhang.markdown-all-in-one",
+
+    // [[wiki-links]], backlinking etc
+    "kortina.vscode-markdown-notes",
+
+    // Understated grayscale theme (light and dark variants)
+    "philipbe.theme-gray-matter"
   ]
 }

.vscode/foam.json

@@ -0,0 +1,4 @@
+{
+  "purpose": "this file exists to tell the foam-vscode plugin that it's currently in a foam workspace",
+  "future": "we may use this for custom configuration"
+}

.vscode/settings.json

@@ -5,5 +5,7 @@
   "editor.overviewRulerBorder": false,
   "editor.lineHeight": 24,
   "workbench.colorTheme": "Gray Matter Light",
-  "cSpell.language": "en-GB"
+  "[markdown]": {
+    "editor.quickSuggestions": true
+  }
 }

foam-tips.md

@@ -0,0 +1,3 @@
+# Foam tips
+
+_For up-to-date tips, see [Foam Recipes](https://foambubble.github.io/foam/recipes)._

foam.md

@@ -0,0 +1,2 @@
+# Foam
+

foam_tips.md

@@ -1,28 +0,0 @@
-## Foam tips
-
-_For up-to-date tips, see [Foam Recipes](https://foambubble.github.io/foam/recipes)._
-
-## Structuring content
-
-**Foam** is a tool that supports creating relationships between thoughts and information to help you think better.
-
-Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/) or a [Zettelkasten](https://zettelkasten.de/posts/overview/), or you want to [GTD](https://gettingthingsdone.com/what-is-gtd/) or just go with the flow, **Foam** can help you organise your thoughts if you follow these simple rules:
-
-1. Consider this **Foam** a workspace for all your knowledge and research.
-2. Write your thoughts in markdown documents (I like to call them **Bubbles**, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. ([source](https://zettelkasten.de/posts/overview/#principles))
-3. Use Foam's shortcuts and autocompletions to link your thoughts together with Markdown links, and navigate between to explore your knowledge graph.
-
-
-## Publishing
-
-New Foams are not published by default. To publish your Foam,enable GitHub Pages on the default branch in repository settings.
-
-If you don't like GitHub pages, you're free to set up any other deployment mechanism of your choosing.
-
-## Useful commands
-
-TODO
-
-## Keyboard shortcuts
-
-TODO

inbox.md

@@ -1,4 +1,4 @@
-## Inbox
+# Inbox
 
 - Here you can write disorganised notes to be categorised later
 - Bullet points are useful, but it could be free form text as well
@@ -6,7 +6,10 @@
 - But don't let this list get too long
 - Move information to more specific documents and link to them.
   - This helps you navigate between documents quickly
-  - For example, you can `Cmd`+`Click` this: [Todo](todo.md)
+  - For example, you can `Cmd`+`Click` this: [[todo]]
 - Some notes don't end up making sense the next day
 - That's ok, you can just delete them!
-  - You can always find them in your git history, if you really need it!
+  - 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"

readme.md

@@ -4,7 +4,11 @@ We've created a few Bubbles (markdown documents) to get you started.
 
 Feel free to use them or delete them. Your Foam, your rules.
 
-- [Inbox](inbox.md) - a place to write down quick notes to be categorised later
-- [Todo](todo.md) - a todo list
-- [Foam tips](foam_tips.md) - tips to get the most out of your foam.
+- [[inbox]] - a place to write down quick notes to be categorised later
+- [[foam]] - tips to get the most out of your foam
+- [[todo]]
 
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[inbox]: inbox.md "Inbox"
+[todo]: todo.md "Todo"
+[//end]: # "Autogenerated link references"

todo.md

@@ -1,7 +1,9 @@
 # Todo
 
 - [x] This is an example of a todo list item that's complete
-- [ ] Todo lists are useful for keeping organised and focused
+- [x] Todo lists are useful for keeping organised and focused
 - [ ] This one is not completed yet
 - [ ] You can mark it completed by pressing `Option`+`C` (or `Alt`+`C`) when your cursor is on this line
-- [ ] When you press enter at the end of a line, it adds a new todo item on the next line
+  - [ ] You can also select multiple lines and mark them all at once!
+- [ ] When you press enter at the end of a line, it adds a new todo item on the next line
+- [ ] This, and more is provided by the [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) plugin by [Yu Zhang](https://github.com/yzhang-gh)