v0.18.1

Also added some tests for both links and wikilinks
Fixes #975

.all-contributorsrc

@@ -688,6 +688,169 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "pderaaij",
+      "name": "Paul de Raaij",
+      "avatar_url": "https://avatars.githubusercontent.com/u/495374?v=4",
+      "profile": "http://www.paulderaaij.nl",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bronson",
+      "name": "Scott Bronson",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1776?v=4",
+      "profile": "https://github.com/bronson",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "rafo",
+      "name": "Rafael Riedel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/41793?v=4",
+      "profile": "http://rafaelriedel.de",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Pearcekieser",
+      "name": "Pearcekieser",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5055971?v=4",
+      "profile": "https://github.com/Pearcekieser",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "theowenyoung",
+      "name": "Owen Young",
+      "avatar_url": "https://avatars.githubusercontent.com/u/62473795?v=4",
+      "profile": "https://github.com/theowenyoung",
+      "contributions": [
+        "doc",
+        "content"
+      ]
+    },
+    {
+      "login": "ksprashu",
+      "name": "Prashanth Subrahmanyam",
+      "avatar_url": "https://avatars.githubusercontent.com/u/476729?v=4",
+      "profile": "http://www.prashu.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "JonasSprenger",
+      "name": "Jonas SPRENGER",
+      "avatar_url": "https://avatars.githubusercontent.com/u/25108895?v=4",
+      "profile": "https://github.com/JonasSprenger",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Laptop765",
+      "name": "Paul",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1468359?v=4",
+      "profile": "https://github.com/Laptop765",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "eltociear",
+      "name": "Ikko Ashimine",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22633385?v=4",
+      "profile": "https://bandism.net/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "memeplex",
+      "name": "memeplex",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2845433?v=4",
+      "profile": "https://github.com/memeplex",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "AndreiD049",
+      "name": "AndreiD049",
+      "avatar_url": "https://avatars.githubusercontent.com/u/52671223?v=4",
+      "profile": "https://github.com/AndreiD049",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "iam-yan",
+      "name": "Yan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48427014?v=4",
+      "profile": "https://github.com/iam-yan",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "jimt",
+      "name": "Jim Tittsler",
+      "avatar_url": "https://avatars.githubusercontent.com/u/180326?v=4",
+      "profile": "https://WikiEducator.org/User:JimTittsler",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "MalcolmMielle",
+      "name": "Malcolm Mielle",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4457840?v=4",
+      "profile": "http://malcolmmielle.wordpress.com/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "veesar",
+      "name": "Veesar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/74916913?v=4",
+      "profile": "https://snippets.page/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "bentongxyz",
+      "name": "bentongxyz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/60358804?v=4",
+      "profile": "https://github.com/bentongxyz",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "techCarpenter",
+      "name": "Brian DeVries",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42778030?v=4",
+      "profile": "https://brianjdevries.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "cliffordfajardo",
+      "name": "Clifford Fajardo ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6743796?v=4",
+      "profile": "http://Cliffordfajardo.com",
+      "contributions": [
+        "tool"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.eslintrc.json

@@ -1,20 +1,44 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module"
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "env": { "node": true, "es6": true },
+  "plugins": ["@typescript-eslint", "import", "jest"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "plugin:jest/recommended"
+  ],
+  "rules": {
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": ["**/src/test/**", "**/src/**/*{test,spec}.ts"]
+      }
+    ]
+  },
+  "settings": {
+    "import/core-modules": ["vscode"],
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
     },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/class-name-casing": "warn",
-        "@typescript-eslint/semi": "warn",
-        "curly": "warn",
-        "eqeqeq": "warn",
-        "no-throw-literal": "warn",
-        "semi": "off",
-        "require-await": "warn"
+    "import/resolver": {
+      "typescript": {
+        "alwaysTryTypes": true
+      }
     }
+  },
+  "ignorePatterns": ["**/core/common/**", "*.js"],
+  "reportUnusedDisableDirectives": true
 }

.github/ISSUE_TEMPLATE/bug.md

@@ -1,23 +0,0 @@
----
-name: Bug report
-about: Create a report to help us be foamier
-labels: bug
----
-
-- Foam version: <!-- Check in the VSCode extension tab. -->
-- Platform: Windows | Mac | Linux
-- Issue occur on the [foam template](https://github.com/foambubble/foam-template) repo: Yes | No
-
-**Summary**
-<!-- A clear and concise description of what the bug is.-->
-
-**Steps to reproduce**
-1.
-2.
-
-**Additional information**
-<!-- Add any other context about the problem here. -->
-Feel free to attach any of the following that might help with debugging the issue:
-- screenshots
-- a zip with a minimal repo to reproduce the issue
-- the Foam log in VsCode (see [instructions](https://github.com/foambubble/foam/blob/master/docs/foam-logging-in-vscode.md))

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,97 @@
+name: 'Bug report'
+description: Create a report to help us improve
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue :pray:.
+
+        This issue tracker is for reporting bugs found in `foam` (https://github.com/foambubble).
+        If you have a question about how to achieve something and are struggling, please post a question
+        inside of either of the following places:
+          - Foam's Discussion's tab: https://github.com/foambubble/foam/discussions
+          - Foam's Discord channel: https://foambubble.github.io/join-discord/g
+          
+
+        Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
+         - Foam's Issue's tab: https://github.com/foambubble/foam/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
+         - Foam's closed issues tab: https://github.com/foambubble/foam/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed
+         - Foam's Discussions tab: https://github.com/foambubble/foam/discussions
+
+        The more information you fill in, the better the community can help you.
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of the challenge you are running into.
+    validations:
+      required: true
+  - type: input
+    id: reproducible_example
+    attributes:
+      label: Small Reproducible Example
+      description: |
+        Note:
+        - Your bug will may get fixed much faster if there is a way we can somehow run your example or code.
+        - To create a shareable example, consider cloning the following Foam Github template: https://github.com/foambubble/foam-template
+        - Please read these tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+      placeholder: |
+        e.g. Link to your github repository containing a small reproducible example that the team can run.
+    validations:
+      required: false
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce the Bug or Issue
+      description: Describe the steps we have to take to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: Provide a clear and concise description of what you expected to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but i am seeing ___
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots_or_videos
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓
+  - type: input
+    id: os
+    attributes:
+      label: Operating System Version
+      description: What opearting system are you using?
+      placeholder: |
+        - OS: [e.g. macOS, Windows, Linux]
+    validations:
+      required: true
+  - type: input
+    id: vscode_version 
+    attributes:
+      label: Visual Studio Code Version
+      description: |
+        What version of Visual Studio Code are you using?
+        How to find Visual Studio Code Version: https://code.visualstudio.com/docs/supporting/FAQ#_how-do-i-find-the-version
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: | 
+        Add any other context about the problem here.
+        The Foam log output for VSCode can be found here: https://github.com/foambubble/foam/blob/master/docs/features/foam-logging-in-vscode.md

.github/ISSUE_TEMPLATE/feature.md

@@ -1,6 +0,0 @@
----
-name: Feature request
-about: Suggest an idea to help us be foamier
----
-
-<!-- Describe the feature you'd like. -->

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,42 @@
+name: Feature request
+description: Suggest an idea for the `Foam` project
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This issue form is for requesting features only!
+        If you want to report a bug, please use the [bug report](https://github.com/foambubble/foam/issues/new?assignees=&labels=&template=bug_report.yml) form.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+      placeholder: |
+        As a user, I expected ___ behavior but ___ ...
+        
+        Ideal Steps I would like to see:
+        1. Go to '...'
+        2. Click on '....'
+        3. ....
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    attributes:
+      label: Screenshots or Videos
+      description: |
+        If applicable, add screenshots or a video to help explain your problem.
+        For more information on the supported file image/file types and the file size limits, please refer
+        to the following link: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files
+      placeholder: |
+        You can drag your video or image files inside of this editor ↓

.github/workflows/ci.yml

@@ -3,17 +3,15 @@ name: CI
 on:
   push:
     branches:
-      - '**'
-  # The following will also make the workflow run on all PRs, internal and external.
-  # This would create duplicate runs, that we are skipping by adding the "if" to the jobs below.
-  # See https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
+      - master
   pull_request:
+    branches:
+      - master
 
 jobs:
   lint:
     name: Lint
     runs-on: ubuntu-18.04
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
     steps:
       - uses: actions/checkout@v1
       - name: Setup Node
@@ -27,7 +25,7 @@ jobs:
             node_modules
             */*/node_modules
             packages/foam-vscode/.vscode-test
-          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('packages/foam-vscode/src/test/run-tests.ts') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
       - name: Install Dependencies
         run: yarn
       - name: Check Lint Rules
@@ -39,7 +37,6 @@ jobs:
       matrix:
         os: [macos-10.15, ubuntu-18.04, windows-2019]
     runs-on: ${{ matrix.os }}
-    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
     env:
       OS: ${{ matrix.os }}
     steps:
@@ -55,12 +52,12 @@ jobs:
             node_modules
             */*/node_modules
             packages/foam-vscode/.vscode-test
-          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('packages/foam-vscode/src/test/run-tests.ts') }}
+          key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
       - name: Install Dependencies
         run: yarn
       - name: Build Packages
         run: yarn build
       - name: Run Tests
-        uses: GabrielBB/xvfb-action@v1.0
+        uses: GabrielBB/xvfb-action@v1.4
         with:
           run: yarn test

.gitignore

@@ -9,3 +9,4 @@ dist
 docs/_site
 docs/.sass-cache
 docs/.jekyll-metadata
+.test-workspace

.vscode/launch.json

@@ -3,83 +3,51 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-  "inputs": [
+  "version": "0.2.0",
+  "configurations": [
     {
-      "id": "packageName",
-      "type": "pickString",
-      "description": "Select the package in which this test is located",
-      "options": ["foam-core", "foam-vscode"],
-      "default": "foam-core"
+      "name": "Debug Jest Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "${workspaceFolder}/packages/foam-vscode/.test-workspace",
+        "--disable-extensions",
+        "--disable-workspace-trust",
+        "--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode",
+        "--extensionTestsPath=${workspaceFolder}/packages/foam-vscode/out/test/suite"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/packages/foam-vscode/out/**/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "name": "Run VSCode Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/packages/foam-vscode/out/**/*.js"
+      ],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "type": "node",
+      "name": "vscode-jest-tests",
+      "request": "launch",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true,
+      "cwd": "${workspaceFolder}/packages/foam-vscode",
+      "runtimeExecutable": "yarn",
+      "args": [
+        "jest",
+        "--runInBand",
+        "--watchAll=false"
+      ]
     }
-  ],
-	"configurations": [
-		{
-			"type": "node",
-			"name": "vscode-jest-tests",
-			"request": "launch",
-			"runtimeArgs": ["workspace", "${input:packageName}", "run", "test"], // ${yarnWorkspaceName} is what we're missing
-			"args": [
-					"--runInBand"
-			],
-			"runtimeExecutable": "yarn",
-			"console": "integratedTerminal",
-			"internalConsoleOptions": "neverOpen",
-			"disableOptimisticBPs": true,
-	},
-		{
-			"name": "Debug Jest Tests",
-			"type": "node",
-			"request": "launch",
-			"runtimeArgs": [
-				"--inspect-brk",
-				"${workspaceRoot}/node_modules/.bin/tsdx",
-				"test",
-			],
-			"console": "integratedTerminal",
-			"cwd": "${workspaceFolder}/packages/foam-core",
-			"internalConsoleOptions": "neverOpen"
-	},
-		{
-			"name": "Run VSCode Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode"
-			],
-			"outFiles": [
-				"${workspaceFolder}/packages/foam-vscode/out/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-
-		// @NOTE: This task is broken. VSCode e2e tests are currently disabled
-		// due to incompability of jest and mocha inside a typescript monorepo
-		// Contributions to fix this are welcome!
-		{
-			"name": "Test VSCode Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode",
-				"--extensionTestsPath=${workspaceFolder}/packages/foam-vscode/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/packages/foam-vscode/out/test/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Test Core",
-			"type": "node",
-			"request": "launch",
-			"program": "${workspaceFolder}/node_modules/tsdx/dist/index.js",
-			"args": ["test"],
-			"cwd": "${workspaceFolder}/packages/foam-core",
-			"internalConsoleOptions": "openOnSessionStart",
-			"preLaunchTask": "${defaultBuildTask}"
-		}
-	]
+  ]
 }

.vscode/settings.json

@@ -12,6 +12,7 @@
   },
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
   "typescript.tsc.autoDetect": "off",
+  "foam.edit.linkReferenceDefinitions": "withExtensions",
   "foam.files.ignore": [
     "**/.vscode/**/*",
     "**/_layouts/**/*",
@@ -19,13 +20,13 @@
     "**/node_modules/**/*",
     "packages/**/*"
   ],
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.requireConfig": true,
-  "editor.formatOnSave": true,
   "editor.tabSize": 2,
-  "jest.debugCodeLens.showWhenTestStateIn": ["fail", "unknown", "pass"],
+  "editor.formatOnSave": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "jest.autoRun": "off",
+  "jest.rootPath": "packages/foam-vscode",
+  "jest.jestCommandLine": "yarn jest",
   "gitdoc.enabled": false,
-  "jest.autoEnable": false,
-  "jest.runAllTestsFirst": false,
   "search.mode": "reuseEditor"
 }

.vscode/tasks.json

@@ -1,31 +1,31 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"label": "watch: foam-vscode",
-			"type": "npm",
-			"script": "start:vscode",
-			"problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "always"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		},
-		{
-			"label": "test: all packages",
-			"type": "npm",
-			"script": "test",
-			"problemMatcher": [],
-			"group": {
-				"kind": "test",
-				"isDefault": true
-			},
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "watch: foam-vscode",
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "always"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "test: all packages",
+      "type": "npm",
+      "script": "test",
+      "problemMatcher": [],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    }
+  ]
 }

.yarnrc

@@ -0,0 +1 @@
+--ignore-engines true

docs/.vscode/extensions.json

@@ -14,9 +14,6 @@
     // Tons of markdown goodies (lists, tables of content, so much more)
     "yzhang.markdown-all-in-one",
 
-    // [[wiki-links]], backlinking etc
-    "kortina.vscode-markdown-notes",
-
     // Graph visualizer
     "tchayen.markdown-links",
 

docs/Gemfile.lock

@@ -203,14 +203,14 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.5.1)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.14.2)
     multipart-post (2.1.1)
-    nokogiri (1.11.1)
+    nokogiri (1.11.5)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     octokit (4.19.0)

docs/_layouts/foam.html

@@ -19,21 +19,21 @@ window.addEventListener('DOMContentLoaded', (event) => {
   document
     .querySelectorAll(".markdown-body a[title]:not([href^=http])")
     .forEach((a) => {
-      // filter to only wiki-links
+      // filter to only wikilinks
       var prev = a.previousSibling;
       var next = a.nextSibling;
       if (
-        prev instanceof Text && prev.textContent.endsWith('[') && 
+        prev instanceof Text && prev.textContent.endsWith('[') &&
         next instanceof Text && next.textContent.startsWith(']')
       ) {
-        
+
         // remove surrounding brackets
         prev.textContent = prev.textContent.slice(0, -1);
         next.textContent = next.textContent.slice(1);
 
         // add CSS list for styling
         a.classList.add('wikilink');
-        
+
         // replace page-link with "Page Title"...
         a.innerText = a.title;
 

docs/contribution-guide.md

@@ -18,8 +18,6 @@ Before you start contributing we recommend that you read the following links:
 We understand that diving in an unfamiliar codebase may seem scary,
 to make it easier for new contributors we provide some resources:
 
-- [[architecture]] - This document describes the architecture of Foam and how the repository is structured.
-
 You can also see [existing issues](https://github.com/foambubble/foam/issues) and help out!
 Finally, the easiest way to help, is to use it and provide feedback by [submitting issues](https://github.com/foambubble/foam/issues/new/choose) or participating in the [Foam Community Discord](https://foambubble.github.io/join-discord/g)!
 
@@ -35,37 +33,59 @@ If you're interested in contributing, this short guide will help you get things
 
    `yarn install`
 
-3. This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). `foam-vscode` relies on `foam-core`. This means we need to compile it before we do any extension development. From the root, run the command:
+3. From the root, run the command:
 
    `yarn build`
 
 You should now be ready to start working!
 
+### Structure of the project
+
+Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
+
+- [/docs](https://github.com/foambubble/foam/tree/master/docs): documentation and [[recipes]].
+
+Exceptions to the monorepo are:
+
+- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
+- All other [[recommended-extensions]] live in their respective GitHub repos
+
+This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). 
+
+Originally Foam had:
+
+- [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core) - Powers the core functionality in Foam across all platforms.
+- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) - The core VS Code plugin.
+
+To improve DX we have moved the `foam-core` module into `packages/foam-vscode/src/core`, but from a development point of view it's useful to think of the `foam-vscode/src/core` "submodule" as something that might be extracted in the future.
+
+For all intents and purposes this means two things:
+
+1. nothing in `foam-vscode/src/core` should depend on files outside of this directory
+2. code in `foam-vscode/src/core` should NOT depend on `vscode` library
+
+We have kept the yarn workspace for the time being as we might use it to pull out `foam-core` in the future, or we might need it for other packages that the VS Code plugin could depend upon (e.g. currently the graph visualization is inside the module, but it might be pulled out if its complexity increases).
+
 ### Testing
 
 Code needs to come with tests.
 We use the following convention in Foam:
 
-- *.test.ts are unit tests
-- *.spec.ts are integration tests
+- `*.test.ts` are unit tests
+- `*.spec.ts` are integration tests
 
-Also, note that tests in `foam-core` live in the `test` directory.
-Tests in `foam-vscode` live alongside the code in `src`.
+Tests live alongside the code in `src`.
 
 ### The VS Code Extension
 
 This guide assumes you read the previous instructions and you're set up to work on Foam.
 
-1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/master/.vscode/launch.json) to start a new extension host of VS Code. From the root, or the `foam-vscode` workspace, press f5.
+1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/master/.vscode/launch.json) to start a new extension host of VS Code. Open the "Run and Debug" Activity (the icon with the bug on the far left) and select "Run VSCode Extension" in the pop-up menu. Now hit F5 or click the green arrow "play" button to fire up a new copy of VS Code with your extension installed.
 
 2. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from [foam-template](https://github.com/foambubble/foam-template)). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.
 
 3. Test a command to make sure it's working as expected. Open the Command Palette (Ctrl/Cmd + Shift + P) and select "Foam: Update Markdown Reference List". If you see no errors, it's good to go!
 
-For more resources related to the VS Code Extension, check out the links below:
-
-- [[tutorial-adding-a-new-command-to-the-vs-code-extension]]
-
 ---
 
 Feel free to modify and submit a PR if this guide is out-of-date or contains errors!
@@ -75,5 +95,6 @@ Feel free to modify and submit a PR if this guide is out-of-date or contains err
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [principles]: principles.md "Principles"
 [code-of-conduct]: code-of-conduct.md "Code of Conduct"
-[architecture]: dev/architecture.md "Architecture"
+[recipes]: recipes/recipes.md "Recipes"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
 [//end]: # "Autogenerated link references"

docs/dev/architecture.md

@@ -1,23 +0,0 @@
----
-tags: architecture
----
-# Architecture
-
-This document aims to provide a quick overview of the Foam architecture!
-
-Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
-
-- [/docs](https://github.com/foambubble/foam/tree/master/docs): documentation and [[recipes]].
-- [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core) - Powers the core functionality in Foam across all platforms.
-- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) - The core VSCode plugin.
-
-Exceptions to the monorepo are:
-
-- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
-- All other [[recommended-extensions]] live in their respective GitHub repos.
-- [foam-cli](https://github.com/foambubble/foam-cli) - The Foam CLI tool.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[recipes]: ../recipes/recipes.md "Recipes"
-[recommended-extensions]: ../recommended-extensions.md "Recommended Extensions"
-[//end]: # "Autogenerated link references"

docs/dev/foam-core.md

@@ -17,7 +17,7 @@
 `foam-core`'s primary responsibility is to build an API on top of a workspace of markdown files, which allows us to:
 
 - Treat files as a graph, based on links
-  - Can be either [[wiki-links]] or relative `[markdown](links.md)` style
+  - Can be either [[wikilinks]] or relative `[markdown](links.md)` style
   - We need to know about the edges (connections) as well as nodes
     - What link points to what other file, etc.
     - Needs to have the exact link text, e.g. even if `[[some-page]]` or `[[some-page.md]]` or `[[Some Page]]` point to the same document (`./some-page.md`), we need to know which format was used, so [[link-reference-definitions]] can be generated correctly
@@ -61,7 +61,7 @@ Here are some example use cases that the core should support. They don't need to
 
 - Adding and editing page content
   - [[materialized-backlinks]]
-  - [[link-reference-definitions]] for [[wiki-links]]
+  - [[link-reference-definitions]] for [[wikilinks]]
   - [Frontmatter](https://jekyllrb.com/docs/front-matter/)
 - Finding all documents with `#tag`
 - Finding all documents with instances of `[[link]]`
@@ -99,7 +99,7 @@ Useful for knowing what needs to be supported. See [[feature-comparison]].
 [workspace-janitor]: ../features/workspace-janitor.md "Janitor"
 [cli]: ../features/cli.md "Command Line Interface"
 [build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [link-reference-definitions]: ../features/link-reference-definitions.md "Link Reference Definitions"
 [materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
 [todo]: todo.md "Todo"

docs/dev/foam-file-format.md

@@ -1,16 +1,16 @@
 # Foam File Format
 
-This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for mediawiki-style `[[wiki-links]]`.
+This file is an example of a valid Foam file. Essentially it's just a markdown file with a bit of additional support for MediaWiki-style `[[wikilinks]]`.
 
-Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wiki-links]]`:
+Here are a few specific constraints, mainly because our tooling is a bit fragmented. Most of these should be eventually lifted, and our requirement should just be "Markdown with `[[wikilinks]]`:
 
 - **The first top level `# Heading` will be used as title for the note.**
   - If not available, we will use the file name
 - **File name should have extension `.md`**
   - This is a temporary limitation and will be lifted in future versions.
   - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code
-- **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.** See [[wiki-links]] for more details.
+- **In addition to normal Markdown Links syntax you can use `[[MediaWiki]]` links.** See [[wikilinks]] for more details.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [//end]: # "Autogenerated link references"

docs/dev/link-reference-definition-improvements.md

@@ -4,13 +4,13 @@
 
 ### File-by-file Insertion
 
-For the time being, if you want to get [[wiki-links]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
+For the time being, if you want to get [[wikilinks]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
 
 ### Wikilinks don't work on GitHub
 
 > **TL;DR;** [workaround](#workaround) in the end of the chapter.
 
-If you click any of the wiki-links on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
+If you click any of the wikilinks on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
 
 At the time of writing (June 28 2020) this is a known, but unsolved error. To understand why this is the case, we need to understand what we are trading off.
 
@@ -59,7 +59,7 @@ Problem space in essence:
     - may clutter the search results
 - During build-time (when converting markdown to html for publishing purposes)
   - link reference definitions are needed, if the files are published via such tools (or to such platforms) that don't understand wikilinks
-  - link reference definitions might have to be in different formats depending on the publish target (e.g. Github pages vs Github UI)
+  - link reference definitions might have to be in different formats depending on the publish target (e.g. GitHub pages vs GitHub UI)
 
 The potential solution:
 
@@ -122,8 +122,8 @@ The potential solution:
 
     ```
 
-  - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the Github UI
-  - Have publish target defined for Github pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
+  - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the GitHub UI
+  - Have publish target defined for GitHub pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
     - This naturally requires first removing the existing link reference definitions during the build
 - Other
   - To clean up the search results, remove link reference definition section guards (assuming that these are not defined by the markdown spec). Use unifiedjs parse trees to identify if there's missing (or surplus) definitions (check if they are identified properly by the library), and just add the needed definitions to the bottom of the file (without guards) AND remove them if they are not needed (anywhere from the file).
@@ -137,7 +137,7 @@ UI-wise, the publish targets could be picked in some similar fashion as the run/
 - [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [link-reference-definitions]: ../features/link-reference-definitions.md "Link Reference Definitions"
 [backlinking]: ../features/backlinking.md "Backlinking"
 [//end]: # "Autogenerated link references"

docs/dev/releasing-foam.md

@@ -0,0 +1,27 @@
+# Releasing Foam
+
+1. Get to the latest code
+   - `git checkout master && git fetch && git rebase`
+2. Sanity checks
+   - `yarn reset`
+   - `yarn test`
+3. Update change log 
+   - `./packages/foam-vscode/CHANGELOG.md`
+   - `git add *`
+   - `git commit -m"Preparation for next release"`
+4. Update version
+   - `$ cd packages/foam-vscode`
+   - `foam-vscode$ yarn lerna version <version>` (where `version` is `patch/minor/major`) 
+   - `cd ../..`
+5. Package extension
+   - `$ yarn vscode:package-extension`
+6. Publish extension
+   - `$ yarn vscode:publish-extension`
+7. Update the release notes in GitHub
+   - in GitHub, top right, click on "releases"
+   - select "tags" in top left
+   - select the tag that was just released, click "edit" and copy release information from changelog
+   - publish (no need to attach artifacts)
+8. Annouce on Discord
+
+Steps 1 to 6 should really be replaced by a GitHub action...

docs/dev/roadmap.md

@@ -25,7 +25,7 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
 - [[improve-default-workspace-settings]]
   - Discussion: [foam#270](https://github.com/foambubble/foam/issues/270)
 - Improve [[git-integration]]
-- Fix [[wiki-links]] compatibility issues
+- Fix [[wikilinks]] compatibility issues
 - Simplify [[foam-file-format]]
 
 ### Core features
@@ -87,7 +87,7 @@ The community is working on a number of automated scripts to help you migrate to
 [recipes]: ../recipes/recipes.md "Recipes"
 [contribution-guide]: ../contribution-guide.md "Contribution Guide"
 [git-integration]: ../features/git-integration.md "Git Integration"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [foam-file-format]: foam-file-format.md "Foam File Format"
 [unlinked-references]: unlinked-references.md "Unlinked references (stub)"
 [make-backlinks-more-prominent]: ../recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent"

docs/features/backlinking.md

@@ -1,6 +1,6 @@
 # Backlinking
 
-When using [[wiki-links]], you can find all notes that link to a specific note in the [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **Backlinks Explorer**
+When using [[wikilinks]], you can find all notes that link to a specific note in the **Backlinks Explorer**
 
 - Run `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "backlinks" and run the **Explorer: Focus on Backlinks** view.
 - Keep this pane always visible to discover relationships between your thoughts
@@ -8,7 +8,7 @@ When using [[wiki-links]], you can find all notes that link to a specific note i
 - Finding backlinks in published Foam workspaces via [[materialized-backlinks]] is on the [[roadmap]] but not yet implemented.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [make-backlinks-more-prominent]: ../recipes/make-backlinks-more-prominent.md "Make Backlinks More Prominent"
 [materialized-backlinks]: ../dev/materialized-backlinks.md "Materialized Backlinks (stub)"
 [roadmap]: ../dev/roadmap.md "Roadmap"

docs/features/creating-new-notes.md

@@ -1,6 +1,6 @@
 # Creating New Notes
 
-- Write out a new `[[wiki-link]]` and `Cmd` + `Click` to create a new file and enter it.
+- Write out a new `[[wikilink]]` and `Cmd` + `Click` to create a new file and enter it.
   - For keyboard navigation, use the 'Follow Definition' key `F12` (or [remap key binding](https://code.visualstudio.com/docs/getstarted/keybindings) to something more ergonomic)
 - `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), execute `Foam: Create New Note` and enter a **Title Case Name** to create `Title Case Name.md`
   - Add a keyboard binding to make creating new notes easier.

docs/features/custom-markdown-preview-styles.md

@@ -13,3 +13,19 @@ For example, to load a stylesheet called `Style.css`, we can update `settings.js
   "markdown.styles": ["Style.css"]
 }
 ```
+
+## Foam elements
+
+### Foam note & placeholder links
+
+It is possible to custom style the links to a note or placeholder. The links are an `<a>` tag. For notes use the class `foam-note-link`, for placeholders use `foam-placeholder-link`.
+
+### Cyclic inclusion warnings
+
+Foams offers the functionality to include other notes in your note. This will be displayed in the preview tab. Foam recognises a cyclic inclusion of notes and will display a warning when detected. The following html is used and can be custom styled using the class `foam-cyclic-link-warning`.
+
+```html
+<div class="foam-cyclic-link-warning">
+  Cyclic link detected for wikilink: ${wikilink}
+</div>
+```

docs/features/daily-notes.md

@@ -25,9 +25,9 @@ The above configuration would create a file `journal/note-2020-07-25.mdx`, with
 
 ## Daily Note Templates
 
-In the future, Foam may provide a functionality for specifying a template for new Daily Notes and other types of documents.
+Daily notes can also make use of [templates](note-templates.md), by defining a special `.foam/templates/daily-note.md` template.
 
-In the meantime, you can use [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets) for defining your own Daily Note template.
+See [Note Templates](note-templates.md) for details of the features available in templates.
 
 ## Roam-style Automatic Daily Notes
 

docs/features/foam-local-plugins.md

@@ -1,60 +0,0 @@
-# Foam Local Plugins
-
-Foam can use workspace plugins to provide customization for users.
-
-## ATTENTION
-
-This feature is experimental and its API subject to change.
-**Local plugins can execute arbitrary code on your machine** - ensure you trust the content of the repo.
-
-## Goal
-
-Here are some of the things that we could enable with local plugins in Foam:
-
-- extend the document syntax to support roam style attributes (e.g. `stage:: seedling`)
-- automatically add tags to my notes based on the location in the repo (e.g. notes in `/areas/finance` will automatically get the `#finance` tag)
-- add a new CLI command to support some internal use case or automate import/export
-- extend the VSCode experience to support one's own workflow, e.g. weekly note, templates, extra panels, foam model derived TOC, ... all without having to write/deploy a VSCode extension
-
-## How to enable local plugins
-
-Plugins can execute arbitrary code on the client's machine.
-For this reason this feature is disabled by default, and needs to be explicitly enabled.
-
-To enable the feature:
-
-- create a `~/.foam/config.json` file
-- add the following content to the file
-
-```
-{
- "experimental": {
-  "localPlugins": {
-   "enabled": true
-  }
- }
-}
-```
-
-For security reasons this setting can only be defined in the user settings file.
-(otherwise a malicious repo could set it via its `./foam/config.json`)
-
-- [[todo]] an additional security mechanism would involve having an explicit list of whitelisted repo paths where plugins are allowed. This would provide finer grain control over when to enable or disable the feature.
-
-## Technical approach
-
-When Foam is loaded it will check whether the experimental local plugin feature is enabled, and in such case it will:
-
-- check `.foam/plugins` directory.
-  - each directory in there is considered a plugin
-  - the layout of each directory is
-    - `index.js` contains the main info about the plugin, specifically it exports:
-      - `name: string` the name of the plugin
-      - `description?: string` the description of the plugin
-      - `parser?: ParserPlugin` an object that interacts with the markdown parsing phase
-
-Currently for simplicity we keep everything in one file. We might in the future split the plugin by domain (e.g. vscode, cli, core, ...)
-
-[//begin]: # 'Autogenerated link references for markdown compatibility'
-[todo]: ../dev/todo.md 'Todo'
-[//end]: # 'Autogenerated link references'

docs/features/including-notes.md

@@ -0,0 +1,20 @@
+# Including notes in a note
+
+In some situations it might be useful to include the content of another note in your current note. Foam supports this displaying within the vscode environment. Note, this does not work out-of-the-box for your publishing solutions.
+
+## Including a note
+
+Including a note can be done by adding an `!` before a wikilink defintion. For example `![[wikilink]]`.
+
+## Custom styling
+
+Displaying the inclusion of notes allows for some custom styling, see [[custom-markdown-preview-styles]]
+
+## Future possibilities
+
+Work on this feature is evolving and progressing. See the [[inclusion-of-notes]] proposal for the current discussion.
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[custom-markdown-preview-styles]: custom-markdown-preview-styles.md "Custom Markdown Preview Styles"
+[inclusion-of-notes]: ../proposals/inclusion-of-notes.md "Inclusion of notes Proposal "
+[//end]: # "Autogenerated link references"

docs/features/link-reference-definitions.md

@@ -2,22 +2,22 @@
 
 ## Introduction
 
-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. 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]]`.
+When you use `[[wikilinks]]`, 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. 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]]`.
 
 ## Example
 
 The following example:
 
   ```md
-  - [[wiki-links]]
+  - [[wikilinks]]
   - [[github-pages]]
   ```
 
 ...generates the following link reference definitions to the bottom of the file:
 
   ```md
-  [wiki-links]: wiki-links "Wiki Links"
-  [github-pages]: github-pages "Github Pages"
+  [wikilinks]: wikilinks "Wikilinks"
+  [github-pages]: github-pages "GitHub Pages"
   ```
 
 You can open the [raw markdown](https://foambubble.github.io/foam/features/link-reference-definitions.md) to see them at the bottom of this file
@@ -26,7 +26,7 @@ You can open the [raw markdown](https://foambubble.github.io/foam/features/link-
 
 The three components of a link reference definition are `[link-label]: link-target "Link Title"`
 
-- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wiki-link]]` notation
+- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wikilink]]` notation
 - **link destination** The target of the matched link
   - By default we generate links without extension. This can be overridden, see [Configuration](#configuration) below
 - **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime)

docs/features/note-templates.md

@@ -24,19 +24,164 @@ To create a note from a template:
 
 _Theme: Ayu Light_
 
-## Default template
+## Special templates
+### Default template
 
 The `.foam/templates/new-note.md` template is special in that it is the template that will be used by the `Foam: Create New Note` command.
 Customize this template to contain content that you want included every time you create a note.
 
+### Default daily note template
+
+The `.foam/templates/daily-note.md` template is special in that it is the template that will be used when creating daily notes (e.g. by using `Foam: Open Daily Note`).
+Customize this template to contain content that you want included every time you create a daily note.
+
 ## Variables
 
 Templates can use all the variables available in [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables).
 
 In addition, you can also use variables provided by Foam:
 
-| Name         | Description                                                                         |
-| ------------ | ----------------------------------------------------------------------------------- |
-| `FOAM_TITLE` | The title of the note. If used, Foam will prompt you to enter a title for the note. |
+| Name                 | Description                                                                                                                                                                                                                 |
+| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `FOAM_SELECTED_TEXT` | Foam will fill it with selected text when creating a new note, if any text is selected. Selected text will be replaced with a wikilink to the new note.                                                                     |
+| `FOAM_TITLE`         | The title of the note. If used, Foam will prompt you to enter a title for the note.                                                                                                                                         |
+| `FOAM_SLUG`          | The sluggified title of the note (using the default github slug method). If used, Foam will prompt you to enter a title for the note unless `FOAM_TITLE` has already caused the prompt.                                     |
+| `FOAM_DATE_*`        | `FOAM_DATE_YEAR`, `FOAM_DATE_MONTH`, etc. Foam-specific versions of [VS Code's datetime snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables). Prefer these versions over VS Code's. |
 
-**Note:** neither the defaulting feature (eg. `${variable:default}`) nor the format feature (eg. `${variable/(.*)/${1:/upcase}/}`) (available to other variables) are available for these Foam-provided variables.
+### `FOAM_DATE_*` variables
+
+Foam defines its own set of datetime variables that have a similar behaviour as [VS Code's datetime snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables).
+
+For example, `FOAM_DATE_YEAR` has the same behaviour as VS Code's `CURRENT_YEAR`, `FOAM_DATE_SECONDS_UNIX` has the same behaviour as `CURRENT_SECONDS_UNIX`, etc.
+
+By default, prefer using the `FOAM_DATE_` versions. The datetime used to compute the values will be the same for both `FOAM_DATE_` and VS Code's variables, with the exception of the creation notes using the daily note template.
+
+#### Relative daily notes
+
+When referring to daily notes, you can use the relative snippets (`/+1d`, `/tomorrow`, etc.). In these cases, the new notes will be created with the daily note template, but the datetime used should be the relative datetime, not the current datetime.
+By using the `FOAM_DATE_` versions of the variables, the correct relative date will populate the variables, instead of the current datetime.
+
+For example, given this daily note template (`.foam/templates/daily-note.md`):
+
+```markdown
+# $FOAM_DATE_YEAR-$FOAM_DATE_MONTH-$FOAM_DATE_DATE
+
+## Here's what I'm going to do today
+
+* Thing 1
+* Thing 2
+```
+
+When the `/tomorrow` snippet is used, `FOAM_DATE_` variables will be populated with tomorrow's date, as expected.
+If instead you were to use the VS Code versions of these variables, they would be populated with today's date, not tomorrow's, causing unexpected behaviour.
+
+When creating notes in any other scenario, the `FOAM_DATE_` values are computed using the same datetime as the VS Code ones, so the `FOAM_DATE_` versions can be used in all scenarios by default.
+
+## Metadata
+
+Templates can also contain metadata about the templates themselves. The metadata is defined in YAML "Frontmatter" blocks within the templates.
+
+| Name          | Description                                                                                                                      |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `filepath`    | The filepath to use when creating the new note. If the filepath is a relative filepath, it is relative to the current workspace. |
+| `name`        | A human readable name to show in the template picker.                                                                            |
+| `description` | A human readable description to show in the template picker.                                                                     |
+
+Foam-specific variables (e.g. `$FOAM_TITLE`) can be used within template metadata. However, VS Code snippet variables are ([currently](https://github.com/foambubble/foam/pull/655)) not supported.
+
+### `filepath` attribute
+
+The `filepath` metadata attribute allows you to define a relative or absolute filepath to use when creating a note using the template.
+If the filepath is a relative filepath, it is relative to the current workspace.
+
+**Note:** While you can make use of the `filepath` attribute in [daily note](daily-notes.md) templates (`.foam/templates/daily-note.md`), there is currently no way to have `filepath` vary based on the date. This will be improved in the future. For now, you can customize the location of daily notes using the [`foam.openDailyNote` settings](daily-notes.md).
+
+#### Example of relative `filepath`
+
+For example, `filepath` can be used to customize `.foam/templates/new-note.md`, overriding the default `Foam: Create New Note` behaviour of opening the file in the same directory as the active file:
+
+```yaml
+---
+# This will create the note in the "journal" subdirectory of the current workspace,
+# regardless of which file is the active file.
+foam_template:
+  filepath: 'journal/$FOAM_TITLE.md'
+---
+```
+
+#### Example of absolute `filepath`
+
+`filepath` can be an absolute filepath, so that the notes get created in the same location, regardless of which file or workspace the editor currently has open.
+The format of an absolute filepath may vary depending on the filesystem used.
+
+```yaml
+---
+foam_template:
+  # Unix / MacOS filesystems
+  filepath: '/Users/john.smith/foam/journal/$FOAM_TITLE.md'
+
+  # Windows filesystems
+  filepath: 'C:\Users\john.smith\Documents\foam\journal\$FOAM_TITLE.md'
+---
+```
+
+### `name` and `description` attributes
+
+These attributes provide a human readable name and description to be shown in the template picker (e.g. When a user uses the `Foam: Create New Note From Template` command):
+
+![Template Picker annotated with attributes](../assets/images/template-picker-annotated.png)
+
+### Adding template metadata to an existing YAML Frontmatter block
+
+If your template already has a YAML Frontmatter block, you can add the Foam template metadata to it.
+
+#### Limitations
+
+Foam only supports adding the template metadata to *YAML* Frontmatter blocks. If the existing Frontmatter block uses some other format (e.g. JSON), you will have to add the template metadata to its own YAML Frontmatter block.
+
+Further, the template metadata must be provided as a [YAML block mapping](https://yaml.org/spec/1.2/spec.html#id2798057), with the attributes placed on the lines immediately following the `foam_template` line:
+
+```yaml
+---
+existing_frontmatter: "Existing Frontmatter block"
+foam_template: # this is a YAML "Block" mapping ("Flow" mappings aren't supported)
+  name: My Note Template # Attributes must be on the lines immediately following `foam_template`
+  description: This is my note template
+  filepath: `journal/$FOAM_TITLE.md`
+---
+This is the rest of the template
+```
+
+Due to the technical limitations of parsing the complex YAML format, unless the metadata is provided this specific form, Foam is unable to correctly remove the template metadata before creating the resulting note.
+
+If this limitation proves inconvenient to you, please let us know. We may be able to extend our parsing capabilities to cover your use case. In the meantime, you can add the template metadata without this limitation by providing it in its own YAML Frontmatter block.
+
+### Adding template metadata to its own YAML Frontmatter block
+
+You can add the template metadata to its own YAML Frontmatter block at the start of the template:
+
+```yaml
+---
+foam_template:
+  name: My Note Template
+  description: This is my note template
+  filepath: `journal/$FOAM_TITLE.md`
+---
+This is the rest of the template
+```
+
+If the note already has a Frontmatter block, a Foam-specific Frontmatter block can be added to the start of the template. The Foam-specific Frontmatter block must always be placed at the very beginning of the file, and only whitespace can separate the two Frontmatter blocks.
+
+```yaml
+---
+foam_template:
+  name: My Note Template
+  description: This is my note template
+  filepath: `journal/$FOAM_TITLE.md`
+---
+
+---
+existing_frontmatter: "Existing Frontmatter block"
+---
+This is the rest of the template
+```

docs/features/tags.md

@@ -9,6 +9,8 @@ There are two ways of creating a tag:
 - adding a `#tag` anywhere in the text of the note
 - using the `tags: tag1, tag2` property in frontmatter
 
+Tags can also be hierarchical, so you can have `#parent/child`.
+
 ## Navigating tags
 
 It's possible to navigate tags via the Tag Explorer panel.

docs/frequently-asked-questions.md

@@ -4,15 +4,19 @@
 
 - [Frequently Asked Questions](#frequently-asked-questions)
   - [Links/Graphs/BackLinks don't work. How do I enable them?](#linksgraphsbacklinks-dont-work-how-do-i-enable-them)
+  - [I don't want Foam enabled for all my workspaces](#i-dont-want-foam-enabled-for-all-my-workspaces)
 
 ## Links/Graphs/BackLinks don't work. How do I enable them?
 
 - Ensure that you have all the [[recommended-extensions]] installed in Visual Studio Code
 - Reload Visual Studio Code by running `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type "reload" and run the **Developer: Reload Window** command to for the updated extensions take effect
-- Check the formatting rules for links on [[foam-file-format]], [[wiki-links]] and [[link-formatting-and-autocompletion]]
+- Check the formatting rules for links on [[foam-file-format]], [[wikilinks]] and [[link-formatting-and-autocompletion]]
+
+## I don't want Foam enabled for all my workspaces
+Any extension you install in Visual Studio Code is enabled by default. Give the philosophy of Foam it works out of the box without doing any configuration upfront. In case you want to disable Foam for a specific workspace, or disable Foam by default and enable it for specific workspaces, it is advised to follow the best practices as [documented by Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_manage-extensions)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [recommended-extensions]: recommended-extensions.md "Recommended Extensions"
 [foam-file-format]: dev/foam-file-format.md "Foam File Format"
-[wiki-links]: wiki-links.md "Wiki Links"
+[wikilinks]: wikilinks.md "Wikilinks"
 [//end]: # "Autogenerated link references"

docs/inbox.md

@@ -19,7 +19,7 @@ Uncategorised thoughts, to be added
   - <https://code.visualstudio.com/api/extension-guides/notebook>
 - Future architecture
   - Could we do publish-related settings as a pre-push git hook, e.g. generating footnote labels
-  - Running them on Github Actions to edit stuff as it comes in
+  - Running them on GitHub Actions to edit stuff as it comes in
     - Ideally, we shouldn't have to touch files, should be just markdown
 - Looking at the errors/warnings/output panes makes me think, what kind of automated quality tools could we write.
   - Deduplication, finding similarities...

docs/index.md

@@ -37,7 +37,7 @@ Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/
 
 1. Create a single **Foam** workspace for all your knowledge and research following the [Getting started](#getting-started) guide.
 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 `[[wiki-links]]`, and navigate between them to explore your knowledge graph.
+3. Use Foam's shortcuts and autocompletions to link your thoughts together with `[[wikilinks]]`, and navigate between them to explore your knowledge graph.
 4. Get an overview of your **Foam** workspace using a [[graph-visualisation]] (⚠️ WIP), and discover relationships between your thoughts with the use of [[backlinking]].
 
 Foam is a like a bathtub: _What you get out of it depends on what you put into it._
@@ -72,6 +72,8 @@ These instructions assume you have a GitHub account, and you have Visual Studio
 
 After setting up the repository, open `.vscode/settings.json` and edit, add or remove any settings you'd like for your Foam workspace.
 
+* *If using a [multi-root workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces) as noted above, make sure that your **Foam** directory is first in the list. There are some settings that will need to be migrated from `.vscode/settings.json` to your `.code-workspace` file.*
+
 To learn more about how to use **Foam**, read the [[recipes]].
 
 Getting stuck in the setup? Read the [[frequently-asked-questions]].
@@ -201,6 +203,30 @@ If that sounds like something you're interested in, I'd love to have you along o
     <td align="center"><a href="https://github.com/daniel-vera-g"><img src="https://avatars.githubusercontent.com/u/28257108?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Daniel VG</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=daniel-vera-g" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/Barabazs"><img src="https://avatars.githubusercontent.com/u/31799121?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Barabas</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Barabazs" title="Code">💻</a></td>
     <td align="center"><a href="http://enginveske@gmail.com"><img src="https://avatars.githubusercontent.com/u/43685404?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Engincan VESKE</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=EngincanV" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.paulderaaij.nl"><img src="https://avatars.githubusercontent.com/u/495374?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Paul de Raaij</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=pderaaij" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/bronson"><img src="https://avatars.githubusercontent.com/u/1776?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Scott Bronson</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=bronson" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://rafaelriedel.de"><img src="https://avatars.githubusercontent.com/u/41793?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Rafael Riedel</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=rafo" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Pearcekieser"><img src="https://avatars.githubusercontent.com/u/5055971?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Pearcekieser</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Pearcekieser" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/theowenyoung"><img src="https://avatars.githubusercontent.com/u/62473795?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Owen Young</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=theowenyoung" title="Documentation">📖</a> <a href="#content-theowenyoung" title="Content">🖋</a></td>
+    <td align="center"><a href="http://www.prashu.com"><img src="https://avatars.githubusercontent.com/u/476729?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Prashanth Subrahmanyam</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ksprashu" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/JonasSprenger"><img src="https://avatars.githubusercontent.com/u/25108895?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Jonas SPRENGER</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=JonasSprenger" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Laptop765"><img src="https://avatars.githubusercontent.com/u/1468359?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Paul</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Laptop765" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://bandism.net/"><img src="https://avatars.githubusercontent.com/u/22633385?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Ikko Ashimine</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=eltociear" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/memeplex"><img src="https://avatars.githubusercontent.com/u/2845433?v=4?s=60" width="60px;" alt=""/><br /><sub><b>memeplex</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=memeplex" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/AndreiD049"><img src="https://avatars.githubusercontent.com/u/52671223?v=4?s=60" width="60px;" alt=""/><br /><sub><b>AndreiD049</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=AndreiD049" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/iam-yan"><img src="https://avatars.githubusercontent.com/u/48427014?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Yan</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=iam-yan" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://WikiEducator.org/User:JimTittsler"><img src="https://avatars.githubusercontent.com/u/180326?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Jim Tittsler</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jimt" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://malcolmmielle.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/4457840?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Malcolm Mielle</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=MalcolmMielle" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://snippets.page/"><img src="https://avatars.githubusercontent.com/u/74916913?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Veesar</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=veesar" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/bentongxyz"><img src="https://avatars.githubusercontent.com/u/60358804?v=4?s=60" width="60px;" alt=""/><br /><sub><b>bentongxyz</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=bentongxyz" title="Code">💻</a></td>
+    <td align="center"><a href="https://brianjdevries.com"><img src="https://avatars.githubusercontent.com/u/42778030?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Brian DeVries</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=techCarpenter" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="http://Cliffordfajardo.com"><img src="https://avatars.githubusercontent.com/u/6743796?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Clifford Fajardo </b></sub></a><br /><a href="#tool-cliffordfajardo" title="Tools">🔧</a></td>
   </tr>
 </table>
 

docs/principles.md

@@ -37,7 +37,7 @@ This principle may seem like it contradicts [Foam wants you to own your thoughts
 
 - **Foam is a collection of ideas.** Foam was released to the public not to share the few good ideas in it, but to learn many good ideas from others. As you improve your own workflow, share your work on your own Foam blog.
 - **Foam is open for contributions.** If you use a tool or workflow that you like that fits these principles, please contribute them back to the Foam template as [[recipes]], [[recommended-extensions]] or documentation in [this workspace](https://github.com/foambubble/foam). See also: [[contribution-guide]].
-- **Foam is open source.** Feel free to fork it, improve it and remix it. Just don't sell it, as per our [license](license).
+- **Foam is open source.** Feel free to fork it, improve it and remix it. Just don't sell it, as per our [license](LICENSE.txt).
 - **Foam is not Roam.** This project was inspired by Roam Research, but we're not limited by what Roam does. No idea is too big (though if it doesn't fit with Foam's core workflow, we might make it a [[recipes]] page instead).
 
 ## Foam is for hackers, not only for programmers

docs/proposals/inclusion-of-notes.md

@@ -0,0 +1,48 @@
+# Inclusion of notes Proposal <!-- omit in TOC -->
+
+Currently it is not possible within Foam to include other notes into a note. Next to including a full note it could be interesting to add functionalities that allow for greater flexibility. This proposal discusses some functionalities around inclusion of notes.
+
+**IMPORTANT: This design is merely a proposal of a design that could be implemented. It DOES NOT represent a commitment by `Foam` developers to implement the features outlined in this document. This document is merely a mechanism to facilitate discussion of a possible future direction for `Foam`.**
+
+- [Introduction](#introduction)
+- [New features](#new-features)
+  - [Including a note](#including-a-note)
+  - [Include a section of a note](#include-a-section-of-a-note)
+  - [Include an attribute of a file (note property or frontmatter)](#include-an-attribute-of-a-file-note-property-or-frontmatter)
+
+## Introduction
+
+Initial work and thought on including a note was ignited by issue [#652](https://github.com/foambubble/foam/issues/652). Requested by a user was a likewise functionality as offered in Obsidian. This was simply the ability to include a note.
+
+Whilst researching digital gardening for my own setup, I came across an in-depth overview by [Maggie Appleton](https://maggieappleton.com/roam-garden). Showing examples of her personal Roam Research I see valuable possibilites to connect more information, if we would add additional functionalities to the possibility of including a note. This proposal displays these possible functionalities and markup.
+
+## New features
+
+### Including a note
+
+The minimal functionality is the ability to fully include a note. Markup used in Obsidian for this is `![[wikilink]]`. For Foam I would suggest to follow this syntax. Benefits being:
+
+- Adds minimal amount of knowledge required as syntax is based on the syntax of creating a wikilink.
+- Makes the auto-complete work ouf-of-the-box, without any additional code and listeners required.
+
+**Important**. A risk exists that a loop of including the same notes arises. E.g. Note A includes note B which includes note A. This needs to be prevented by the implementation and made visible to the user.
+
+### Include a section of a note
+
+It could be interesting to only include a section of a note instead of the entire note. In order to do so thse user should be able to use the following syntax:
+
+`![[wikilink#section-b]]`
+
+As a result it will include the section title + section content until the next section *or* end of file.
+
+### Include an attribute of a file (note property or frontmatter)
+
+As a user I could be interested in collecting the value of any given proeprty for a note. For example, I might want to include the tags as defined in the frontmatter of note A. This should be possible via the syntax:
+
+`![[wikilink:<property>]]`
+
+The property value should be lookedup by foam defined properties, e.g. title, **or** any property defined in the frontmatter of a note.
+
+So, the example of including the tags of a note should be:
+
+`![[wikilink:tags]]`

docs/proposals/wikilinks-in-foam.md

@@ -0,0 +1,93 @@
+# Wikilinks in Foam
+
+Foam supports standard wikilinks in the format `[[wikilink]]`.
+
+Wikilinks can refer to any note or attachment in the repo: `[[note.md]]`, `[[doc.pdf]]`, `[[image.jpg]]`.
+
+The usual wikilink syntax without extension refers to notes: `[[wikilink]]` and `[[wikilink.md]]` are equivalent.
+
+The goal of wikilinks is to uniquely identify a file in a repo, no matter in which directory it lives.
+
+Sometimes in a repo you can have files with the same name in different directories.
+Foam allows you to identify those files using the minimum effort needed to disambiguate them.
+
+This is achieved by adding as many directories above the file needed to uniquely identify the link, e.g. `[[house/todo]]`.
+
+See below for more details.
+
+## Goals for wikilinks in Foam
+
+Wikilinks in Foam are meant to satisfy the following:
+- make it easy for users to identify a resource
+- make it interoperable with other similar note taking systems (Obsidian, Dendron, ...)
+- be easy to get started with, but satisfy growing needs
+
+## Types of wikilinks supported in Foam
+
+Foam supports two types of keys inside a wikilink: a **path** reference and an **identifier** reference:
+
+- `[[./file]]` and `[[../to/another/file]]` are **path** links to a resource, relative _from the source_
+- `[[/path/to/file]]` is a **path** link to a resource, relative _from the repo root_
+- `[[file]]` is an **identifier** of a resource (based on the filename)
+- `[[path/to/file]]` is an **identifier** of a resource (based on the path), the same is true for `[[to/file]]`
+
+It's important to note that sometimes identifier keys can't uniquely locale a resource.
+
+A more concrete example will help:
+
+```
+/
+  projects/
+    house/
+      todo.md
+    buy-car/
+      todo.md
+      cars.md
+  work/
+    todo.md
+    notes.md
+```
+
+In the above repo:
+
+- `[[cars]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[todo]]` is an non-unique identifier as it can refer to multiple resources
+- `[[house/todo]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[projects/house/todo]]` is a unique identifier of a resource - it can be used anywhere in the repo
+- `[[/projects/house/todo]]` is a path reference to a resource
+- `[[./todo]]` is a path reference to a resource (e.g. from `/projects/buy-car/cars.md`)
+
+Basically we could say as a rule:
+
+- if the link starts with `/` or `.` we consider it a **path** reference, in the first case from the repo root, otherwise from the source note
+- if a link doesn't start with `/` or `.` it is an **identifier**
+  - generally speaking we use the shortest identifier available to identify a resource, **but all are valid**
+    - `[[projects/buy-car/cars]]`, `[[buy-car/cars]]`, `[[cars]]` are all unique identifier to the same resource, and are all valid in a document
+    - the same can be said for `[[projects/house/todo]]` and `[[house/todo]]` - but not for `[[todo]]`, because it can refer to more than one resource
+
+## Compatibility with other apps
+
+| Scenario                    | Obsidian                        | Foam                            |
+| --------------------------- | ------------------------------- | ------------------------------- |
+| 1 `[[notes]]`               | ✔ unique identifier in repo     | ✔ unique identifier in repo     |
+| 2 `[[/work/notes]]`         | ✔ valid path from repo root     | ✔ valid path from repo root     |
+| 3 `[[work/notes]]`          | ✔ valid path from repo root     | ✔ valid identifier in repo      |
+| 4 `[[project/house/todo]]`  | ✔ valid path from repo root     | ✔ valid unique identifier       |
+| 5 `[[/project/house/todo]]` | ✔ valid path from repo root     | ✔ valid path from repo root     |
+| 6 `[[house/todo]]`          | ✔ valid unique identifier       | ✔ valid unique identifier       |
+| 7 `[[todo]]`                | ✘ ambiguous identifier          | ✘ ambiguous identifier          |
+| 8 `[[/house/todo]]`         | ✘ incorrect path from repo root | ✘ incorrect path from repo root |
+
+## Non-unique identifiers
+
+We can't prevent non-unique identifiers from occurring in Foam (first and foremost because a file could be edited with another editor) but we can flag them. 
+
+Therefore Foam follows the following strategy instead:
+
+1. there is a clear resolution mechanism (alphabetic) so that if nothing changes a non-unique identifier will always return the same note. Resolution has to be deterministic
+2. a diagnostic entry (warning or error) is showed to the user for non-unique identifiers, so she knows that she's using a "risky" identifier
+   1. The quick resolution for this item will show the available unique identifiers matching the non-unique one
+
+## Thanks 
+
+Thanks to [@memplex](https://github.com/memeplex) for helping with the thinking around this proposal.

docs/publishing/generate-gatsby-site.md

@@ -2,11 +2,11 @@
 
 ## Using foam-gatsby-template
 
-You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on Github or [Vercel](https://vercel.com).
+You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on GitHub or [Vercel](https://vercel.com).
 
 ### Publishing your foam to GitHub pages
 
-It comes configured with Github actions to auto deploy to Github pages when changes are pushed to your main branch.
+It comes configured with GitHub actions to auto deploy to GitHub pages when changes are pushed to your main branch.
 
 ### Publishing your foam to Vercel
 
@@ -17,7 +17,7 @@ cd _layouts
 npm run build
 ```
 
-Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to Github.
+Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to GitHub.
 
 Log into your Vercel account. (Create one if you don't have it already.)
 
@@ -28,3 +28,7 @@ That's it!
 ## Using foam-template-gatsby-kb
 
 You can use another template [foam-template-gatsby-kb](https://github.com/hikerpig/foam-template-gatsby-kb), and host it on [Vercel](https://vercel.com) or [Netlify](https://www.netlify.com/).
+
+## Using foam-template-gatsby-theme-primer-wiki
+
+You can use another template [foam-template-gatsby-theme-primer-wiki](https://github.com/theowenyoung/foam-template-gatsby-theme-primer-wiki), ([Demo](https://demo-wiki.owenyoung.com/)), and host it on Github Pages, [Vercel](https://vercel.com) or [Netlify](https://www.netlify.com/).

docs/publishing/publish-to-github-pages.md

@@ -1,10 +1,10 @@
-# Github Pages
+# GitHub Pages
 
-- In VSCode workspace settings set `"foam.edit.linkReferenceDefinitions": "withoutExtensions"`
-- Execute the “Foam: Run Janitor” command from the command palette.
-- [Turn **GitHub Pages** on in your repository settings](https://guides.github.com/features/pages/).
-- The default GitHub Pages template is called [Primer](https://github.com/pages-themes/primer). See Primer docs for how to customise html layouts and templates.
-- GitHub Pages is built on [Jekyll](https://jekyllrb.com/), so it supports things like permalinks, front matter metadata etc.
+1. In VSCode workspace settings set `"foam.edit.linkReferenceDefinitions": "withoutExtensions"`
+2. Execute the “Foam: Run Janitor” command from the command palette.
+3. [Turn **GitHub Pages** on in your repository settings](https://guides.github.com/features/pages/).
+   - The default GitHub Pages template is called [Primer](https://github.com/pages-themes/primer). See Primer docs for how to customise html layouts and templates.
+   - GitHub Pages is built on [Jekyll](https://jekyllrb.com/), so it supports things like permalinks, front matter metadata etc.
 
 ## How to publish locally
 

docs/publishing/publish-to-gitlab-pages.md

@@ -2,13 +2,175 @@
 
 You don't have to use GitHub to serve Foam pages. You can also use GitLab.
 
+Gitlab pages can be kept private for private repo, so that your notes are still private.
+
 ## Setup a project
 
 ### Generate the directory from GitHub
 
-Generate a solution using the [Foam template].
+Generate a solution using the [Foam template](https://github.com/foambubble/foam-template).
 
-Change the remote to GitLab, or copy all the files into a new GitLab repo.
+Change the remote to GitLab, or copy all the files into a new GitLab repo
+
+## Publishing pages with Gatsby
+
+### Setup the Gatsby config
+
+Add a .gatsby-config.js file where:
+
+* `$REPO_NAME` correspond to the name of your gtlab repo.
+* `$USER_NAME` correspond to your gitlab username.
+
+```js
+const path = require("path");
+const pathPrefix = `/$REPO_NAME`;
+
+// Change me
+const siteMetadata = {
+  title: "A title",
+  shortName: "A short name",
+  description: "",
+  imageUrl: "/graph-visualisation.jpg",
+  siteUrl: "https://$USER_NAME.gitlab.io",
+};
+module.exports = {
+  siteMetadata,
+  pathPrefix,
+  flags: {
+    DEV_SSR: true,
+  },
+  plugins: [
+    `gatsby-plugin-sharp`,
+    {
+      resolve: "gatsby-theme-primer-wiki",
+      options: {
+        defaultColorMode: "night",
+        icon: "./path_to/logo.png",
+        sidebarComponents: ["tag", "category"],
+        nav: [
+          {
+            title: "Github",
+            url: "https://github.com/$USER_NAME/",
+          },
+          {
+            title: "Gitlab",
+            url: "https://gitlab.com/$USER_NAME/",
+          },
+        ],
+        editUrl:
+          "https://gitlab.com/$USER_NAME/$REPO_NAME/tree/main/",
+      },
+    },
+    {
+      resolve: "gatsby-source-filesystem",
+      options: {
+        name: "content",
+        path: `${__dirname}`,
+        ignore: [`**/\.*/**/*`],
+      },
+    },
+
+    {
+      resolve: "gatsby-plugin-manifest",
+      options: {
+        name: siteMetadata.title,
+        short_name: siteMetadata.shortName,
+        start_url: pathPrefix,
+        background_color: `#f7f0eb`,
+        display: `standalone`,
+        icon: path.resolve(__dirname, "./path_to/logo.png"),
+      },
+    },
+    {
+      resolve: `gatsby-plugin-sitemap`,
+    },
+    {
+      resolve: "gatsby-plugin-robots-txt",
+      options: {
+        host: siteMetadata.siteUrl,
+        sitemap: `${siteMetadata.siteUrl}/sitemap/sitemap-index.xml`,
+        policy: [{ userAgent: "*", allow: "/" }],
+      },
+    },
+  ],
+};
+```
+
+And a `package.json` file containing:
+
+```json
+{
+    "private": true,
+    "name": "wiki",
+    "version": "1.0.0",
+    "license": "MIT",
+    "scripts": {
+        "develop": "gatsby develop -H 0.0.0.0",
+        "start": "gatsby develop -H 0.0.0.0",
+        "build": "gatsby build",
+        "clean": "gatsby clean",
+        "serve": "gatsby serve",
+        "test": "echo test"
+    },
+    "dependencies": {
+        "@primer/react": "^34.1.0",
+        "@primer/css": "^17.5.0",
+        "foam-cli": "^0.11.0",
+        "gatsby": "^3.12.0",
+        "gatsby-plugin-manifest": "^3.12.0",
+        "gatsby-plugin-robots-txt": "^1.6.9",
+        "gatsby-plugin-sitemap": "^5.4.0",
+        "gatsby-source-filesystem": "^3.12.0",
+        "gatsby-theme-primer-wiki": "^1.14.5",
+        "react": "^17.0.2",
+        "react-dom": "^17.0.2"
+    }
+}
+```
+
+The theme will be based on [gatsby-theme-primer-wiki](https://github.com/theowenyoung/gatsby-theme-primer-wiki).
+
+To test the theme locally first run `yarn install` and then use `gatsby develop` to serve the website.
+See gatsby documentation for more details.
+
+### Set-up the CI for deployment
+
+Create a `.gitlab-ci.yml` file containing:
+
+```yml
+# To contribute improvements to CI/CD templates, please follow the Development guide at:
+# https://docs.gitlab.com/ee/development/cicd/templates.html
+# This specific template is located at:
+# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Pages/Gatsby.gitlab-ci.yml
+
+image: node:latest
+
+stages:
+  - deploy
+
+pages:
+  stage: deploy
+  # This folder is cached between builds
+  # https://docs.gitlab.com/ee/ci/yaml/index.html#cache
+  cache:
+    paths:
+      - node_modules/
+      # Enables git-lab CI caching. Both .cache and public must be cached, otherwise builds will fail.
+      - .cache/
+      - public/
+  script:
+    - yarn install
+    - ./node_modules/.bin/gatsby build --prefix-paths
+  artifacts:
+    paths:
+      - public
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+```
+
+This pipeline will now serve your website on every push to the main branch of your project.
+
+## Publish with Jekyll
 
 ### Add a _config.yaml
 
@@ -47,14 +209,14 @@ gem "jekyll-optional-front-matter"
 
 Commit the file and push it to gitlab.
 
-## Setup CI/CD
+### Setup CI/CD
 
 1. From the project home in GitLab click `Set up CI/CD`
 2. Choose `Jekyll` as your template from the template dropdown
 3. Click `commit`
 4. Now when you go to CI / CD > Pipelines, you should see the code running
 
-## Troubleshooting
+### Troubleshooting
 
 - *Could not locate Gemfile* - You didn't follow the steps above to [#Add a Gemlock file]
 - *Conversion error: Jekyll::Converters::Scss encountered an error while converting* You need to reference a theme.

docs/publishing/publish-to-vercel.md

@@ -82,6 +82,6 @@ Finally, if all is successful, Vercel will show the detected framework: Jekyll.
 And now, Vercel will take care of building and rendering our foam workspace each time on push. Vercel will publish our site to `xxx.vercel.app`, we can also define a custom domain name for our Vercel website.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[publish-to-github-pages]: publish-to-github-pages.md "Github Pages"
+[publish-to-github-pages]: publish-to-github-pages.md "GitHub Pages"
 [math-support-with-katex]: math-support-with-katex.md "Katex Math Rendering"
 [//end]: # "Autogenerated link references"

docs/recipes/capture-notes-with-drafts-pro.md

@@ -30,7 +30,7 @@ With this #recipe you can create notes on your iOS device, which will automatica
     2. the repository name of your Foam repo
     3. the GitHub access token from step 7
     4. An author name
-11. Check your Github repo for a commit
+11. Check your GitHub repo for a commit
 12. If you are publishing your Foam to the web you may want to edit your publishing configuration to exclude inbox files - as publishing (and method) is a user choice that is beyond the scope of this recipe
 
 ## Code for Drafts Action

docs/recipes/diagrams-in-markdown.md

@@ -11,8 +11,6 @@ We have two alternative #recipe for displaying diagrams in markdown:
 
 You can use [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) plugin to draw and preview diagrams in your content.
 
-⚠️ Be aware that Mermaid diagrams don't automatically get rendered in published Foams in [[publish-to-github-pages]], and would require you to eject to another static site generation approach that supports Mermaid plugins.
-
 ## Draw.io
 
 [Draw.io](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) extension allows you to create, edit, and display your diagrams without leaving Visual Studio Code. The `.drawio.svg` or `.drawio.png` files can be automatically embedded and displayed in published Foams, no export needed. FYI, the diagram below was made using Draw.io! You can check the diagram [here](../assets/images/diagram-drawio-demo.drawio.svg).
@@ -27,5 +25,5 @@ You can use [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierne
 4. Embed the diagram file as you embedding the image file, for example: `![My Diagram](my-diagram.drawio.svg)`
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "Github Pages"
+[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "GitHub Pages"
 [//end]: # "Autogenerated link references"

docs/recipes/recipes.md

@@ -37,7 +37,7 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work
 
 ## Write
 
-- Link documents with [[wiki-links]].
+- Link documents with [[wikilinks]].
 - Use shortcuts for [[creating-new-notes]]
 - Instantly create and access your [[daily-notes]]
 - Add and explore [[tags]]
@@ -56,6 +56,7 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work
   - _More..._
 - VS Code Advanced Features [[todo]] [[good-first-task]]
   - Focus with Zen Mode
+- Display content of other notes in the preview tab by [[including-notes]]
 
 ## Version control
 
@@ -112,7 +113,7 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._
 [graph-visualisation]: ../features/graph-visualisation.md "Graph Visualisation"
 [backlinking]: ../features/backlinking.md "Backlinking"
 [unlinked-references]: ../dev/unlinked-references.md "Unlinked references (stub)"
-[wiki-links]: ../wiki-links.md "Wiki Links"
+[wikilinks]: ../wikilinks.md "Wikilinks"
 [creating-new-notes]: ../features/creating-new-notes.md "Creating New Notes"
 [daily-notes]: ../features/daily-notes.md "Daily notes"
 [tags]: ../features/tags.md "Tags"
@@ -125,9 +126,10 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._
 [add-images-to-notes]: add-images-to-notes.md "Add images to your notes"
 [shows-image-preview-on-hover]: shows-image-preview-on-hover.md "Shows Image Preview on Hover"
 [good-first-task]: ../dev/good-first-task.md "Good First Task"
+[including-notes]: ../features/including-notes.md "Including notes in a note"
 [git-integration]: ../features/git-integration.md "Git Integration"
 [write-your-notes-in-github-gist]: write-your-notes-in-github-gist.md "Write your notes in GitHub Gist"
-[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "Github Pages"
+[publish-to-github-pages]: ../publishing/publish-to-github-pages.md "GitHub Pages"
 [publish-to-gitlab-pages]: ../publishing/publish-to-gitlab-pages.md "GitLab Pages"
 [publish-to-azure-devops-wiki]: ../publishing/publish-to-azure-devops-wiki.md "Publish to Azure DevOps Wiki"
 [publish-to-vercel]: ../publishing/publish-to-vercel.md "Publish to Vercel"

docs/recipes/take-notes-from-mobile-phone.md

@@ -15,7 +15,7 @@ Pros
 - Provides functionality to edit, create, and browser markdown files.
 - Support journal mode, todo lists, and free writing
 - Syncs to GitHub repo
-- Supports Wiki Links
+- Supports Wikilinks
 - Supports Backlinks
 - Developer is happy to prioritize Foam compatibility
 

docs/recipes/web-clipper.md

@@ -9,3 +9,6 @@ There are a couple of options when it comes to clipping web pages:
 
 - [Markdown Clipper](https://github.com/deathau/markdownload)
   - A Firefox and Google Chrome extension to clip websites and download them into a readable markdown file.
+
+- [Web Clipper](https://clipper.website/)
+  - A Firefox, Chrome and Edge extension to clip websites and save them directly to the GitHub repository into a readable markdown file.

docs/recipes/write-your-notes-in-github-gist.md

@@ -34,7 +34,7 @@ Once you've opened/created the Foam repository, it will appear in the `Repositor
 
 ## Editing your workspace
 
-When you create or open a page, you can edit the markdown content as usual, as well as [paste images](https://github.com/vsls-contrib/gistpad#pasting-images-1), and create [`[[links]]` to other pages](https://github.com/vsls-contrib/gistpad#links). When you type `[[`, you'll recieve auto-completion for the existing pages in your workspace, and you can also automatically create new pages by simply creating a link to it.
+When you create or open a page, you can edit the markdown content as usual, as well as [paste images](https://github.com/vsls-contrib/gistpad#pasting-images-1), and create [`[[links]]` to other pages](https://github.com/vsls-contrib/gistpad#links). When you type `[[`, you'll receive auto-completion for the existing pages in your workspace, and you can also automatically create new pages by simply creating a link to it.
 
 Since you're using the Visual Studio Code markdown editor, you can benefit from all of the rich language services (e.g. syntax highlighting, header collapsing), as well as the extension ecosystem (e.g. [Emojisense](https://marketplace.visualstudio.com/items?itemName=bierner.emojisense)).
 

docs/recommended-extensions.md

@@ -5,9 +5,9 @@ These extensions defined in `.vscode/extensions.json` are automatically installe
 This list is subject to change. Especially the Git ones.
 
 - [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) (alpha)
-- [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
-- [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links)
 - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
+- [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
+- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
 
 ## Extensions For Additional Features
 
@@ -15,10 +15,11 @@ These extensions are not (yet?) defined in `.vscode/extensions.json`, but have b
 
 - [Emojisense](https://marketplace.visualstudio.com/items?itemName=bierner.emojisense)
 - [Markdown Emoji](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-emoji) (adds `:smile:` syntax, works with emojisense to provide autocomplete for this syntax)
-- [Mermaid Support for Preview](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
+- [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
 - [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
 - [VSCode PDF Viewing](https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf)
-- [Git Lens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
-- [Markdown Extended](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) (with `kbd` option disabled, `kbd` turns wiki-links into non-clickable buttons)
+- [Project Manager](https://marketplace.visualstudio.com/items?itemName=alefragnani.project-manager) (to quickly switch between projects)
+- [Markdown Extended](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) (with `kbd` option disabled, `kbd` turns wikilinks into non-clickable buttons)
 - [GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc) (easy version management via git auto commits)
 - [Markdown Footnotes](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-footnotes) (Adds [^footnote] syntax support to VS Code's built-in markdown preview)
+- [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree) (Searches workspace for TODO and related comments and summarizes those lines in vs-code gutter)

docs/wikilinks.md

@@ -1,27 +1,33 @@
-# Wiki Links
+# Wikilinks
 
-Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[media-wiki]]` links).
+Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[MediaWiki]]` 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.
 - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on file name to navigate to file (`F12` also works while your cursor is on the file name)
 - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on non-existent file to create that file in the workspace.
+  - The note creation makes use of the special [`new-note.md` note template](features/note-templates)
 
 > If the `F12` shortcut feels unnatural you can rebind it at File > Preferences > Keyboard Shortcuts by searching for `editor.action.revealDefinition`.
 
+## Support for sections
+
+Foam supports autocompletion, navigation, embedding and diagnostics for note sections. Just use the standard wiki syntax of `[[resource#Section Title]]`.
+
 ## Markdown compatibility
 
-The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wiki-links compatible with Markdown tools and parsers.
+The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wikilinks compatible with Markdown tools and parsers.
 
 ## Read more
 
 - [[foam-file-format]]
+- [[note-templates]]
 - [[link-formatting-and-autocompletion]]
 - See [[link-reference-definition-improvements]] for further discussion on current problems and potential solutions.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [link-reference-definitions]: features/link-reference-definitions.md "Link Reference Definitions"
 [foam-file-format]: dev/foam-file-format.md "Foam File Format"
+[note-templates]: features/note-templates.md "Note Templates"
 [link-reference-definition-improvements]: dev/link-reference-definition-improvements.md "Link Reference Definition Improvements"
 [//end]: # "Autogenerated link references"

lerna.json

@@ -4,5 +4,5 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.13.2"
+  "version": "0.18.1"
 }

package.json

@@ -9,10 +9,6 @@
     "packages/*"
   ],
   "scripts": {
-    "start:vscode": "yarn workspace foam-vscode vscode:start-debugging",
-    "build:core": "yarn workspace foam-core build",
-    "watch:core": "yarn workspace foam-core start",
-    "test:core": "yarn workspace foam-core test",
     "vscode:package-extension": "yarn workspace foam-vscode package-extension",
     "vscode:install-extension": "yarn workspace foam-vscode install-extension",
     "vscode:publish-extension": "yarn workspace foam-vscode publish-extension",

packages/foam-core/.babelrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-  plugins: [['@babel/plugin-transform-runtime', { helpers: false }]],
-};

packages/foam-core/README.md

@@ -1,21 +0,0 @@
-# Foam Core
-
-This module contains the core functions, model, and API of Foam.
-It is used by its clients to integrate Foam in various use cases, from VsCode extension, to CLI, to CI integrations.
-
-## Local Development
-
-Below is a list of commands you will probably find useful.
-
-### `yarn watch`
-
-Runs the project in development/watch mode. Your project will be rebuilt upon changes.
-
-### `yarn build`
-
-Bundles the package to the `dist` folder. The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).
-
-### `yarn test`
-
-Runs the test watcher (Jest) in an interactive mode.
-By default, runs tests related to files changed since the last commit.

packages/foam-core/package.json

@@ -1,48 +0,0 @@
-{
-  "name": "foam-core",
-  "repository": "https://github.com/foambubble/foam",
-  "version": "0.13.2",
-  "license": "MIT",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "tsdx build --tsconfig ./tsconfig.build.json",
-    "test": "tsdx test",
-    "lint": "tsdx lint src test",
-    "watch": "tsdx watch",
-    "prepare": "tsdx build --tsconfig ./tsconfig.build.json"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.10.4",
-    "@babel/plugin-transform-runtime": "^7.10.4",
-    "@babel/preset-env": "^7.10.4",
-    "@babel/preset-typescript": "^7.10.4",
-    "@types/github-slugger": "^1.3.0",
-    "@types/lodash": "^4.14.157",
-    "@types/micromatch": "^4.0.1",
-    "@types/picomatch": "^2.2.1",
-    "husky": "^4.2.5",
-    "tsdx": "^0.13.2",
-    "tslib": "^2.0.0",
-    "typescript": "^3.9.5"
-  },
-  "dependencies": {
-    "detect-newline": "^3.1.0",
-    "fast-array-diff": "^1.0.0",
-    "github-slugger": "^1.3.0",
-    "glob": "^7.1.6",
-    "lodash": "^4.17.19",
-    "micromatch": "^4.0.2",
-    "remark-frontmatter": "^2.0.0",
-    "remark-parse": "^8.0.2",
-    "remark-wiki-link": "^0.0.4",
-    "title-case": "^3.0.2",
-    "unified": "^9.0.0",
-    "unist-util-visit": "^2.0.2",
-    "yaml": "^1.10.0"
-  },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts"
-}

packages/foam-core/src/bootstrap.ts

@@ -1,39 +0,0 @@
-import { createMarkdownParser } from './markdown-provider';
-import { FoamConfig, Foam, IDataStore, FoamGraph } from './index';
-import { FoamWorkspace } from './model/workspace';
-import { Matcher } from './services/datastore';
-import { ResourceProvider } from 'model/provider';
-
-export const bootstrap = async (
-  config: FoamConfig,
-  dataStore: IDataStore,
-  initialProviders: ResourceProvider[]
-) => {
-  const parser = createMarkdownParser([]);
-  const matcher = new Matcher(
-    config.workspaceFolders,
-    config.includeGlobs,
-    config.ignoreGlobs
-  );
-  const workspace = new FoamWorkspace();
-  const graph = FoamGraph.fromWorkspace(workspace, true);
-
-  const foam: Foam = {
-    workspace,
-    graph,
-    config,
-    services: {
-      dataStore,
-      parser,
-      matcher,
-    },
-    dispose: () => {
-      workspace.dispose();
-      graph.dispose();
-    },
-  };
-
-  await Promise.all(initialProviders.map(p => workspace.registerProvider(p)));
-
-  return foam;
-};

packages/foam-core/src/config.ts

@@ -1,75 +0,0 @@
-import { readFileSync } from 'fs';
-import { merge } from 'lodash';
-import { Logger } from './utils/log';
-import { URI } from './model/uri';
-
-export interface FoamConfig {
-  workspaceFolders: URI[];
-  includeGlobs: string[];
-  ignoreGlobs: string[];
-  get<T>(path: string): T | undefined;
-  get<T>(path: string, defaultValue: T): T;
-}
-
-const DEFAULT_INCLUDES = ['**/*'];
-
-const DEFAULT_IGNORES = ['**/node_modules/**'];
-
-export const createConfigFromObject = (
-  workspaceFolders: URI[],
-  include: string[],
-  ignore: string[],
-  settings: any
-) => {
-  const config: FoamConfig = {
-    workspaceFolders: workspaceFolders,
-    includeGlobs: include,
-    ignoreGlobs: ignore,
-    get: <T>(path: string, defaultValue?: T) => {
-      const tokens = path.split('.');
-      const value = tokens.reduce((acc, t) => acc?.[t], settings);
-      return value ?? defaultValue;
-    },
-  };
-  return config;
-};
-
-export const createConfigFromFolders = (
-  workspaceFolders: URI[] | URI,
-  options: {
-    include?: string[];
-    ignore?: string[];
-  } = {}
-): FoamConfig => {
-  if (!Array.isArray(workspaceFolders)) {
-    workspaceFolders = [workspaceFolders];
-  }
-  const workspaceConfig: any = workspaceFolders.reduce(
-    (acc, f) => merge(acc, parseConfig(URI.joinPath(f, 'config.json'))),
-    {}
-  );
-  // For security reasons local plugins can only be
-  // activated via user config
-  if ('experimental' in workspaceConfig) {
-    delete workspaceConfig['experimental']['localPlugins'];
-  }
-
-  const userConfig = parseConfig(URI.file(`~/.foam/config.json`));
-
-  const settings = merge(workspaceConfig, userConfig);
-
-  return createConfigFromObject(
-    workspaceFolders,
-    options.include ?? DEFAULT_INCLUDES,
-    options.ignore ?? DEFAULT_IGNORES,
-    settings
-  );
-};
-
-const parseConfig = (path: URI) => {
-  try {
-    return JSON.parse(readFileSync(URI.toFsPath(path), 'utf8'));
-  } catch {
-    Logger.debug('Could not read configuration from ' + path);
-  }
-};

packages/foam-core/src/index.ts

@@ -1,73 +0,0 @@
-import {
-  Resource,
-  ResourceLink,
-  NoteLinkDefinition,
-  ResourceParser,
-} from './model/note';
-import { FoamConfig } from './config';
-import {
-  IDataStore,
-  FileDataStore,
-  Matcher,
-  IMatcher,
-} from './services/datastore';
-import { ILogger } from './utils/log';
-import { IDisposable, isDisposable } from './common/lifecycle';
-import { FoamWorkspace } from './model/workspace';
-import { FoamGraph } from '../src/model/graph';
-import { URI } from './model/uri';
-
-export { Position } from './model/position';
-export { Range } from './model/range';
-export { IDataStore, FileDataStore, Matcher, IMatcher };
-export { ILogger };
-export { LogLevel, LogLevelThreshold, Logger, BaseLogger } from './utils/log';
-export { Event, Emitter } from './common/event';
-export { FoamConfig };
-export { ResourceProvider } from './model/provider';
-export { IDisposable, isDisposable };
-
-export {
-  createMarkdownReferences,
-  stringifyMarkdownLinkReferenceDefinition,
-  createMarkdownParser,
-  MarkdownResourceProvider,
-} from './markdown-provider';
-
-export {
-  TextEdit,
-  generateHeading,
-  generateLinkReferences,
-  getKebabCaseFileName,
-  LINK_REFERENCE_DEFINITION_HEADER,
-  LINK_REFERENCE_DEFINITION_FOOTER,
-} from './janitor';
-
-export { applyTextEdit } from './janitor/apply-text-edit';
-
-export { createConfigFromFolders } from './config';
-
-export { bootstrap } from './bootstrap';
-
-export {
-  Resource,
-  ResourceLink,
-  URI,
-  FoamWorkspace,
-  FoamGraph,
-  NoteLinkDefinition,
-  ResourceParser,
-};
-
-export interface Services {
-  dataStore: IDataStore;
-  parser: ResourceParser;
-  matcher: IMatcher;
-}
-
-export interface Foam extends IDisposable {
-  services: Services;
-  workspace: FoamWorkspace;
-  graph: FoamGraph;
-  config: FoamConfig;
-}

packages/foam-core/src/markdown-provider.ts

@@ -1,457 +0,0 @@
-import { Node, Position as AstPosition } from 'unist';
-import unified from 'unified';
-import markdownParse from 'remark-parse';
-import wikiLinkPlugin from 'remark-wiki-link';
-import frontmatterPlugin from 'remark-frontmatter';
-import { parse as parseYAML } from 'yaml';
-import visit from 'unist-util-visit';
-import { Parent, Point } from 'unist';
-import detectNewline from 'detect-newline';
-import os from 'os';
-import {
-  NoteLinkDefinition,
-  Resource,
-  ResourceLink,
-  WikiLink,
-  ResourceParser,
-} from './model/note';
-import { Position } from './model/position';
-import { Range } from './model/range';
-import {
-  dropExtension,
-  extractHashtags,
-  extractTagsFromProp,
-  isNone,
-  isSome,
-} from './utils';
-import { ParserPlugin } from './plugins';
-import { Logger } from './utils/log';
-import { URI } from './model/uri';
-import { FoamWorkspace } from './model/workspace';
-import { ResourceProvider } from 'model/provider';
-import { IDataStore, FileDataStore, IMatcher } from './services/datastore';
-import { IDisposable } from 'common/lifecycle';
-
-export class MarkdownResourceProvider implements ResourceProvider {
-  private disposables: IDisposable[] = [];
-
-  constructor(
-    private readonly matcher: IMatcher,
-    private readonly watcherInit?: (triggers: {
-      onDidChange: (uri: URI) => void;
-      onDidCreate: (uri: URI) => void;
-      onDidDelete: (uri: URI) => void;
-    }) => IDisposable[],
-    private readonly parser: ResourceParser = createMarkdownParser([]),
-    private readonly dataStore: IDataStore = new FileDataStore()
-  ) {}
-
-  async init(workspace: FoamWorkspace) {
-    const filesByFolder = await Promise.all(
-      this.matcher.include.map(glob => this.dataStore.list(glob))
-    );
-    const files = this.matcher.match(filesByFolder.flat());
-
-    await Promise.all(
-      files.map(async uri => {
-        Logger.info('Found: ' + URI.toString(uri));
-        if (this.match(uri)) {
-          const content = await this.dataStore.read(uri);
-          if (isSome(content)) {
-            workspace.set(this.parser.parse(uri, content));
-          }
-        }
-      })
-    );
-
-    this.disposables =
-      this.watcherInit?.({
-        onDidChange: async uri => {
-          if (this.matcher.isMatch(uri)) {
-            const content = await this.dataStore.read(uri);
-            isSome(content) &&
-              workspace.set(await this.parser.parse(uri, content));
-          }
-        },
-        onDidCreate: async uri => {
-          if (this.matcher.isMatch(uri)) {
-            const content = await this.dataStore.read(uri);
-            isSome(content) &&
-              workspace.set(await this.parser.parse(uri, content));
-          }
-        },
-        onDidDelete: uri => {
-          this.matcher.isMatch(uri) && workspace.delete(uri);
-        },
-      }) ?? [];
-  }
-
-  match(uri: URI) {
-    return URI.isMarkdownFile(uri);
-  }
-
-  read(uri: URI): Promise<string | null> {
-    return this.dataStore.read(uri);
-  }
-
-  readAsMarkdown(uri: URI): Promise<string | null> {
-    return this.dataStore.read(uri);
-  }
-
-  async fetch(uri: URI) {
-    const content = await this.read(uri);
-    return isSome(content) ? this.parser.parse(uri, content) : null;
-  }
-
-  resolveLink(
-    workspace: FoamWorkspace,
-    resource: Resource,
-    link: ResourceLink
-  ) {
-    let targetUri: URI | undefined;
-    switch (link.type) {
-      case 'wikilink':
-        const definitionUri = resource.definitions.find(
-          def => def.label === link.slug
-        )?.url;
-        if (isSome(definitionUri)) {
-          const definedUri = URI.resolve(definitionUri, resource.uri);
-          targetUri =
-            workspace.find(definedUri, resource.uri)?.uri ??
-            URI.placeholder(definedUri.path);
-        } else {
-          targetUri =
-            workspace.find(link.slug, resource.uri)?.uri ??
-            URI.placeholder(link.slug);
-        }
-        break;
-
-      case 'link':
-        targetUri =
-          workspace.find(link.target, resource.uri)?.uri ??
-          URI.placeholder(URI.resolve(link.target, resource.uri).path);
-        break;
-    }
-    return targetUri;
-  }
-
-  dispose() {
-    this.disposables.forEach(d => d.dispose());
-  }
-}
-
-/**
- * Traverses all the children of the given node, extracts
- * the text from them, and returns it concatenated.
- *
- * @param root the node from which to start collecting text
- */
-const getTextFromChildren = (root: Node): string => {
-  let text = '';
-  visit(root, 'text', node => {
-    if (node.type === 'text') {
-      text = text + node.value;
-    }
-  });
-  return text;
-};
-
-const tagsPlugin: ParserPlugin = {
-  name: 'tags',
-  onWillVisitTree: (tree, note) => {
-    note.tags = extractHashtags(note.source.text);
-  },
-  onDidFindProperties: (props, note) => {
-    const yamlTags = extractTagsFromProp(props.tags);
-    yamlTags.forEach(tag => note.tags.add(tag));
-  },
-};
-
-const titlePlugin: ParserPlugin = {
-  name: 'title',
-  visit: (node, note) => {
-    if (note.title === '' && node.type === 'heading' && node.depth === 1) {
-      note.title =
-        ((node as Parent)!.children?.[0]?.value as string) || note.title;
-    }
-  },
-  onDidFindProperties: (props, note) => {
-    // Give precendence to the title from the frontmatter if it exists
-    note.title = props.title ?? note.title;
-  },
-  onDidVisitTree: (tree, note) => {
-    if (note.title === '') {
-      note.title = URI.getBasename(note.uri);
-    }
-  },
-};
-
-const wikilinkPlugin: ParserPlugin = {
-  name: 'wikilink',
-  visit: (node, note) => {
-    if (node.type === 'wikiLink') {
-      note.links.push({
-        type: 'wikilink',
-        slug: node.value as string,
-        target: node.value as string,
-        range: astPositionToFoamRange(node.position!),
-      });
-    }
-    if (node.type === 'link') {
-      const targetUri = (node as any).url;
-      const uri = URI.resolve(targetUri, note.uri);
-      if (uri.scheme !== 'file' || uri.path === note.uri.path) {
-        return;
-      }
-      const label = getTextFromChildren(node);
-      note.links.push({
-        type: 'link',
-        target: targetUri,
-        label: label,
-        range: astPositionToFoamRange(node.position!),
-      });
-    }
-  },
-};
-
-const definitionsPlugin: ParserPlugin = {
-  name: 'definitions',
-  visit: (node, note) => {
-    if (node.type === 'definition') {
-      note.definitions.push({
-        label: node.label as string,
-        url: node.url as string,
-        title: node.title as string,
-        range: astPositionToFoamRange(node.position!),
-      });
-    }
-  },
-  onDidVisitTree: (tree, note) => {
-    note.definitions = getFoamDefinitions(note.definitions, note.source.end);
-  },
-};
-
-const handleError = (
-  plugin: ParserPlugin,
-  fnName: string,
-  uri: URI | undefined,
-  e: Error
-): void => {
-  const name = plugin.name || '';
-  Logger.warn(
-    `Error while executing [${fnName}] in plugin [${name}] for file [${uri?.path}]`,
-    e
-  );
-};
-
-export function createMarkdownParser(
-  extraPlugins: ParserPlugin[]
-): ResourceParser {
-  const parser = unified()
-    .use(markdownParse, { gfm: true })
-    .use(frontmatterPlugin, ['yaml'])
-    .use(wikiLinkPlugin);
-
-  const plugins = [
-    titlePlugin,
-    wikilinkPlugin,
-    definitionsPlugin,
-    tagsPlugin,
-    ...extraPlugins,
-  ];
-
-  plugins.forEach(plugin => {
-    try {
-      plugin.onDidInitializeParser?.(parser);
-    } catch (e) {
-      handleError(plugin, 'onDidInitializeParser', undefined, e);
-    }
-  });
-
-  const foamParser: ResourceParser = {
-    parse: (uri: URI, markdown: string): Resource => {
-      Logger.debug('Parsing:', uri);
-      markdown = plugins.reduce((acc, plugin) => {
-        try {
-          return plugin.onWillParseMarkdown?.(acc) || acc;
-        } catch (e) {
-          handleError(plugin, 'onWillParseMarkdown', uri, e);
-          return acc;
-        }
-      }, markdown);
-      const tree = parser.parse(markdown);
-      const eol = detectNewline(markdown) || os.EOL;
-
-      var note: Resource = {
-        uri: uri,
-        type: 'note',
-        properties: {},
-        title: '',
-        tags: new Set(),
-        links: [],
-        definitions: [],
-        source: {
-          text: markdown,
-          contentStart: astPointToFoamPosition(tree.position!.start),
-          end: astPointToFoamPosition(tree.position!.end),
-          eol: eol,
-        },
-      };
-
-      plugins.forEach(plugin => {
-        try {
-          plugin.onWillVisitTree?.(tree, note);
-        } catch (e) {
-          handleError(plugin, 'onWillVisitTree', uri, e);
-        }
-      });
-      visit(tree, node => {
-        if (node.type === 'yaml') {
-          try {
-            const yamlProperties = parseYAML(node.value as string) ?? {};
-            note.properties = {
-              ...note.properties,
-              ...yamlProperties,
-            };
-            // Give precendence to the title from the frontmatter if it exists
-            note.title = note.properties.title ?? note.title;
-            // Update the start position of the note by exluding the metadata
-            note.source.contentStart = Position.create(
-              node.position!.end.line! + 2,
-              0
-            );
-
-            for (let i = 0, len = plugins.length; i < len; i++) {
-              try {
-                plugins[i].onDidFindProperties?.(yamlProperties, note);
-              } catch (e) {
-                handleError(plugins[i], 'onDidFindProperties', uri, e);
-              }
-            }
-          } catch (e) {
-            Logger.warn(`Error while parsing YAML for [${uri}]`, e);
-          }
-        }
-
-        for (let i = 0, len = plugins.length; i < len; i++) {
-          try {
-            plugins[i].visit?.(node, note);
-          } catch (e) {
-            handleError(plugins[i], 'visit', uri, e);
-          }
-        }
-      });
-      plugins.forEach(plugin => {
-        try {
-          plugin.onDidVisitTree?.(tree, note);
-        } catch (e) {
-          handleError(plugin, 'onDidVisitTree', uri, e);
-        }
-      });
-      Logger.debug('Result:', note);
-      return note;
-    },
-  };
-  return foamParser;
-}
-
-function getFoamDefinitions(
-  defs: NoteLinkDefinition[],
-  fileEndPoint: Position
-): NoteLinkDefinition[] {
-  let previousLine = fileEndPoint.line;
-  let foamDefinitions = [];
-
-  // walk through each definition in reverse order
-  // (last one first)
-  for (const def of defs.reverse()) {
-    // if this definition is more than 2 lines above the
-    // previous one below it (or file end), that means we
-    // have exited the trailing definition block, and should bail
-    const start = def.range!.start.line;
-    if (start < previousLine - 2) {
-      break;
-    }
-
-    foamDefinitions.unshift(def);
-    previousLine = def.range!.end.line;
-  }
-
-  return foamDefinitions;
-}
-
-export function stringifyMarkdownLinkReferenceDefinition(
-  definition: NoteLinkDefinition
-) {
-  let text = `[${definition.label}]: ${definition.url}`;
-  if (definition.title) {
-    text = `${text} "${definition.title}"`;
-  }
-
-  return text;
-}
-export function createMarkdownReferences(
-  workspace: FoamWorkspace,
-  noteUri: URI,
-  includeExtension: boolean
-): NoteLinkDefinition[] {
-  const source = workspace.find(noteUri);
-  // Should never occur since we're already in a file,
-  if (source?.type !== 'note') {
-    console.warn(
-      `Note ${noteUri} note found in workspace when attempting to generate markdown reference list`
-    );
-    return [];
-  }
-
-  return source.links
-    .filter(isWikilink)
-    .map(link => {
-      const targetUri = workspace.resolveLink(source, link);
-      const target = workspace.find(targetUri);
-      if (isNone(target)) {
-        Logger.warn(`Link ${targetUri} in ${noteUri} is not valid.`);
-        return null;
-      }
-      if (target.type === 'placeholder') {
-        // no need to create definitions for placeholders
-        return null;
-      }
-
-      const relativePath = URI.relativePath(noteUri, target.uri);
-      const pathToNote = includeExtension
-        ? relativePath
-        : dropExtension(relativePath);
-
-      // [wiki-link-text]: path/to/file.md "Page title"
-      return { label: link.slug, url: pathToNote, title: target.title };
-    })
-    .filter(isSome)
-    .sort();
-}
-
-/**
- * Converts the 1-index Point object into the VS Code 0-index Position object
- * @param point ast Point (1-indexed)
- * @returns Foam Position  (0-indexed)
- */
-const astPointToFoamPosition = (point: Point): Position => {
-  return Position.create(point.line - 1, point.column - 1);
-};
-
-/**
- * Converts the 1-index Position object into the VS Code 0-index Range object
- * @param position an ast Position object (1-indexed)
- * @returns Foam Range  (0-indexed)
- */
-const astPositionToFoamRange = (pos: AstPosition): Range =>
-  Range.create(
-    pos.start.line - 1,
-    pos.start.column - 1,
-    pos.end.line - 1,
-    pos.end.column - 1
-  );
-
-const isWikilink = (link: ResourceLink): link is WikiLink => {
-  return link.type === 'wikilink';
-};

packages/foam-core/src/model/graph.ts

@@ -1,232 +0,0 @@
-import { diff } from 'fast-array-diff';
-import { isEqual } from 'lodash';
-import { Resource, ResourceLink } from './note';
-import { URI } from './uri';
-import { IDisposable } from '../index';
-import { FoamWorkspace, uriToResourceName } from './workspace';
-import { Range } from './range';
-
-export type Connection = {
-  source: URI;
-  target: URI;
-  link: ResourceLink;
-};
-
-const pathToPlaceholderId = (value: string) => value;
-const uriToPlaceholderId = (uri: URI) => pathToPlaceholderId(uri.path);
-
-export class FoamGraph implements IDisposable {
-  /**
-   * Placehoders by key / slug / value
-   */
-  public readonly placeholders: { [key: string]: URI } = {};
-  /**
-   * Maps the connections starting from a URI
-   */
-  public readonly links: { [key: string]: Connection[] } = {};
-  /**
-   * Maps the connections arriving to a URI
-   */
-  public readonly backlinks: { [key: string]: Connection[] } = {};
-
-  /**
-   * List of disposables to destroy with the workspace
-   */
-  private disposables: IDisposable[] = [];
-
-  constructor(private readonly workspace: FoamWorkspace) {}
-
-  public contains(uri: URI): boolean {
-    return this.getConnections(uri).length > 0;
-  }
-
-  public getAllNodes(): URI[] {
-    return [
-      ...Object.values(this.placeholders),
-      ...this.workspace.list().map(r => r.uri),
-    ];
-  }
-
-  public getAllConnections(): Connection[] {
-    return Object.values(this.links).flat();
-  }
-
-  public getConnections(uri: URI): Connection[] {
-    return [
-      ...(this.links[uri.path] || []),
-      ...(this.backlinks[uri.path] || []),
-    ];
-  }
-
-  public getLinks(uri: URI): Connection[] {
-    return this.links[uri.path] ?? [];
-  }
-
-  public getBacklinks(uri: URI): Connection[] {
-    return this.backlinks[uri.path] ?? [];
-  }
-
-  /**
-   * Computes all the links in the workspace, connecting notes and
-   * creating placeholders.
-   *
-   * @param workspace the target workspace
-   * @param keepMonitoring whether to recompute the links when the workspace changes
-   * @returns the FoamGraph
-   */
-  public static fromWorkspace(
-    workspace: FoamWorkspace,
-    keepMonitoring: boolean = false
-  ): FoamGraph {
-    let graph = new FoamGraph(workspace);
-
-    Object.values(workspace.list()).forEach(resource =>
-      graph.resolveResource(resource)
-    );
-    if (keepMonitoring) {
-      graph.disposables.push(
-        workspace.onDidAdd(resource => {
-          graph.updateLinksRelatedToAddedResource(resource);
-        }),
-        workspace.onDidUpdate(change => {
-          graph.updateLinksForResource(change.old, change.new);
-        }),
-        workspace.onDidDelete(resource => {
-          graph.updateLinksRelatedToDeletedResource(resource);
-        })
-      );
-    }
-    return graph;
-  }
-
-  private updateLinksRelatedToAddedResource(resource: Resource) {
-    // check if any existing connection can be filled by new resource
-    const name = uriToResourceName(resource.uri);
-    if (name in this.placeholders) {
-      const placeholder = this.placeholders[name];
-      delete this.placeholders[name];
-      const resourcesToUpdate = this.backlinks[placeholder.path] ?? [];
-      resourcesToUpdate.forEach(res =>
-        this.resolveResource(this.workspace.get(res.source))
-      );
-    }
-
-    // resolve the resource
-    this.resolveResource(resource);
-  }
-
-  private updateLinksForResource(oldResource: Resource, newResource: Resource) {
-    if (oldResource.uri.path !== newResource.uri.path) {
-      throw new Error(
-        'Unexpected State: update should only be called on same resource ' +
-          {
-            old: oldResource,
-            new: newResource,
-          }
-      );
-    }
-    if (oldResource.type === 'note' && newResource.type === 'note') {
-      const patch = diff(oldResource.links, newResource.links, isEqual);
-      patch.removed.forEach(link => {
-        const target = this.workspace.resolveLink(oldResource, link);
-        return this.disconnect(oldResource.uri, target, link);
-      }, this);
-      patch.added.forEach(link => {
-        const target = this.workspace.resolveLink(newResource, link);
-        return this.connect(newResource.uri, target, link);
-      }, this);
-    }
-    return this;
-  }
-
-  private updateLinksRelatedToDeletedResource(resource: Resource) {
-    const uri = resource.uri;
-
-    // remove forward links from old resource
-    const resourcesPointedByDeletedNote = this.links[uri.path] ?? [];
-    delete this.links[uri.path];
-    resourcesPointedByDeletedNote.forEach(connection =>
-      this.disconnect(uri, connection.target, connection.link)
-    );
-
-    // recompute previous links to old resource
-    const notesPointingToDeletedResource = this.backlinks[uri.path] ?? [];
-    delete this.backlinks[uri.path];
-    notesPointingToDeletedResource.forEach(link =>
-      this.resolveResource(this.workspace.get(link.source))
-    );
-    return this;
-  }
-
-  private connect(source: URI, target: URI, link: ResourceLink) {
-    const connection = { source, target, link };
-
-    this.links[source.path] = this.links[source.path] ?? [];
-    this.links[source.path].push(connection);
-    this.backlinks[target.path] = this.backlinks[target.path] ?? [];
-    this.backlinks[target.path].push(connection);
-
-    if (URI.isPlaceholder(target)) {
-      this.placeholders[uriToPlaceholderId(target)] = target;
-    }
-    return this;
-  }
-
-  /**
-   * Removes a connection, or all connections, between the source and
-   * target resources
-   *
-   * @param workspace the Foam workspace
-   * @param source the source resource
-   * @param target the target resource
-   * @param link the link reference, or `true` to remove all links
-   * @returns the updated Foam workspace
-   */
-  private disconnect(source: URI, target: URI, link: ResourceLink | true) {
-    const connectionsToKeep =
-      link === true
-        ? (c: Connection) =>
-            !URI.isEqual(source, c.source) || !URI.isEqual(target, c.target)
-        : (c: Connection) => !isSameConnection({ source, target, link }, c);
-
-    this.links[source.path] =
-      this.links[source.path]?.filter(connectionsToKeep) ?? [];
-    if (this.links[source.path].length === 0) {
-      delete this.links[source.path];
-    }
-    this.backlinks[target.path] =
-      this.backlinks[target.path]?.filter(connectionsToKeep) ?? [];
-    if (this.backlinks[target.path].length === 0) {
-      delete this.backlinks[target.path];
-      if (URI.isPlaceholder(target)) {
-        delete this.placeholders[uriToPlaceholderId(target)];
-      }
-    }
-    return this;
-  }
-
-  public resolveResource(resource: Resource) {
-    delete this.links[resource.uri.path];
-    // prettier-ignore
-    resource.links.forEach(link => {
-      const targetUri = this.workspace.resolveLink(resource, link);
-      this.connect(resource.uri, targetUri, link);
-    });
-    return this;
-  }
-
-  public dispose(): void {
-    this.disposables.forEach(d => d.dispose());
-    this.disposables = [];
-  }
-}
-
-// TODO move these utility fns to appropriate places
-
-const isSameConnection = (a: Connection, b: Connection) =>
-  URI.isEqual(a.source, b.source) &&
-  URI.isEqual(a.target, b.target) &&
-  isSameLink(a.link, b.link);
-
-const isSameLink = (a: ResourceLink, b: ResourceLink) =>
-  a.type === b.type && Range.isEqual(a.range, b.range);

packages/foam-core/src/model/workspace.ts

@@ -1,164 +0,0 @@
-import * as path from 'path';
-import { Resource, ResourceLink } from './note';
-import { URI } from './uri';
-import { isSome, isNone } from '../utils';
-import { Emitter } from '../common/event';
-import { IDisposable } from '../index';
-import { ResourceProvider } from './provider';
-
-export function getReferenceType(
-  reference: URI | string
-): 'uri' | 'absolute-path' | 'relative-path' | 'key' {
-  if (URI.isUri(reference)) {
-    return 'uri';
-  }
-  const isPath = reference.split('/').length > 1;
-  if (!isPath) {
-    return 'key';
-  }
-  const isAbsPath = isPath && reference.startsWith('/');
-  return isAbsPath ? 'absolute-path' : 'relative-path';
-}
-
-const pathToResourceId = (pathValue: string) => {
-  const { ext } = path.parse(pathValue);
-  return ext.length > 0 ? pathValue : pathValue + '.md';
-};
-const uriToResourceId = (uri: URI) => pathToResourceId(uri.path);
-
-const pathToResourceName = (pathValue: string) => path.parse(pathValue).name;
-export const uriToResourceName = (uri: URI) => pathToResourceName(uri.path);
-
-export class FoamWorkspace implements IDisposable {
-  private onDidAddEmitter = new Emitter<Resource>();
-  private onDidUpdateEmitter = new Emitter<{ old: Resource; new: Resource }>();
-  private onDidDeleteEmitter = new Emitter<Resource>();
-  onDidAdd = this.onDidAddEmitter.event;
-  onDidUpdate = this.onDidUpdateEmitter.event;
-  onDidDelete = this.onDidDeleteEmitter.event;
-
-  private providers: ResourceProvider[] = [];
-
-  /**
-   * Resources by key / slug
-   */
-  private resourcesByName: { [key: string]: string[] } = {};
-  /**
-   * Resources by URI
-   */
-  private resources: { [key: string]: Resource } = {};
-
-  registerProvider(provider: ResourceProvider) {
-    this.providers.push(provider);
-    return provider.init(this);
-  }
-
-  set(resource: Resource) {
-    const id = uriToResourceId(resource.uri);
-    const old = this.find(resource.uri);
-    const name = uriToResourceName(resource.uri);
-    this.resources[id] = resource;
-    this.resourcesByName[name] = this.resourcesByName[name] ?? [];
-    this.resourcesByName[name].push(id);
-    isSome(old)
-      ? this.onDidUpdateEmitter.fire({ old: old, new: resource })
-      : this.onDidAddEmitter.fire(resource);
-    return this;
-  }
-
-  delete(uri: URI) {
-    const id = uriToResourceId(uri);
-    const deleted = this.resources[id];
-    delete this.resources[id];
-
-    const name = uriToResourceName(uri);
-    this.resourcesByName[name] =
-      this.resourcesByName[name]?.filter(resId => resId !== id) ?? [];
-    if (this.resourcesByName[name].length === 0) {
-      delete this.resourcesByName[name];
-    }
-
-    isSome(deleted) && this.onDidDeleteEmitter.fire(deleted);
-    return deleted ?? null;
-  }
-
-  public exists(uri: URI): boolean {
-    return (
-      !URI.isPlaceholder(uri) && isSome(this.resources[uriToResourceId(uri)])
-    );
-  }
-
-  public list(): Resource[] {
-    return Object.values(this.resources);
-  }
-
-  public get(uri: URI): Resource {
-    const note = this.find(uri);
-    if (isSome(note)) {
-      return note;
-    } else {
-      throw new Error('Resource not found: ' + uri.path);
-    }
-  }
-
-  public find(resourceId: URI | string, reference?: URI): Resource | null {
-    const refType = getReferenceType(resourceId);
-    switch (refType) {
-      case 'uri':
-        const uri = resourceId as URI;
-        return this.exists(uri) ? this.resources[uriToResourceId(uri)] : null;
-
-      case 'key':
-        const name = pathToResourceName(resourceId as string);
-        const paths = this.resourcesByName[name];
-        if (isNone(paths) || paths.length === 0) {
-          return null;
-        }
-        // prettier-ignore
-        const sortedPaths = paths.length === 1
-          ? paths
-          : paths.sort((a, b) => a.localeCompare(b));
-        return this.resources[sortedPaths[0]];
-
-      case 'absolute-path':
-        const resourceUri = URI.file(resourceId as string);
-        return this.resources[uriToResourceId(resourceUri)] ?? null;
-
-      case 'relative-path':
-        if (isNone(reference)) {
-          return null;
-        }
-        const relativePath = resourceId as string;
-        const targetUri = URI.computeRelativeURI(reference, relativePath);
-        return this.resources[uriToResourceId(targetUri)] ?? null;
-
-      default:
-        throw new Error('Unexpected reference type: ' + refType);
-    }
-  }
-
-  public resolveLink(resource: Resource, link: ResourceLink): URI {
-    // TODO add tests
-    const provider = this.providers.find(p => p.match(resource.uri));
-    return (
-      provider?.resolveLink(this, resource, link) ??
-      URI.placeholder(link.target)
-    );
-  }
-
-  public read(uri: URI): Promise<string | null> {
-    const provider = this.providers.find(p => p.match(uri));
-    return provider?.read(uri) ?? Promise.resolve(null);
-  }
-
-  public readAsMarkdown(uri: URI): Promise<string | null> {
-    const provider = this.providers.find(p => p.match(uri));
-    return provider?.readAsMarkdown(uri) ?? Promise.resolve(null);
-  }
-
-  public dispose(): void {
-    this.onDidAddEmitter.dispose();
-    this.onDidDeleteEmitter.dispose();
-    this.onDidUpdateEmitter.dispose();
-  }
-}

packages/foam-core/src/plugins/index.ts

@@ -1,86 +0,0 @@
-import * as fs from 'fs';
-import path from 'path';
-import { Node } from 'unist';
-import { isNotNull } from '../utils';
-import { Resource } from '../model/note';
-import unified from 'unified';
-import { FoamConfig } from '../config';
-import { Logger } from '../utils/log';
-import { URI } from '../model/uri';
-
-export interface FoamPlugin {
-  name: string;
-  description?: string;
-  parser?: ParserPlugin;
-}
-
-export interface ParserPlugin {
-  name?: string;
-  visit?: (node: Node, note: Resource) => void;
-  onDidInitializeParser?: (parser: unified.Processor) => void;
-  onWillParseMarkdown?: (markdown: string) => string;
-  onWillVisitTree?: (tree: Node, note: Resource) => void;
-  onDidVisitTree?: (tree: Node, note: Resource) => void;
-  onDidFindProperties?: (properties: any, note: Resource) => void;
-}
-
-export interface PluginConfig {
-  enabled?: boolean;
-  pluginFolders?: string[];
-}
-
-export const SETTINGS_PATH = 'experimental.localPlugins';
-
-export async function loadPlugins(config: FoamConfig): Promise<FoamPlugin[]> {
-  const pluginConfig = config.get<PluginConfig>(SETTINGS_PATH, {});
-  const isFeatureEnabled = pluginConfig.enabled ?? false;
-  if (!isFeatureEnabled) {
-    return [];
-  }
-  const pluginDirs: URI[] =
-    pluginConfig.pluginFolders?.map(URI.file) ??
-    findPluginDirs(config.workspaceFolders);
-
-  const plugins = await Promise.all(
-    pluginDirs
-      .filter(dir => fs.statSync(URI.toFsPath(dir)).isDirectory)
-      .map(async dir => {
-        try {
-          const pluginFile = path.join(URI.toFsPath(dir), 'index.js');
-          fs.accessSync(pluginFile);
-          Logger.info(`Found plugin at [${pluginFile}]. Loading..`);
-          const plugin = validate(await import(pluginFile));
-          return plugin;
-        } catch (e) {
-          Logger.error(`Error while loading plugin at [${dir}] - skipping`, e);
-          return null;
-        }
-      })
-  );
-  return plugins.filter(isNotNull);
-}
-
-function findPluginDirs(workspaceFolders: URI[]) {
-  return workspaceFolders
-    .map(root => URI.joinPath(root, '.foam', 'plugins'))
-    .reduce((acc, pluginDir) => {
-      try {
-        const content = fs
-          .readdirSync(URI.toFsPath(pluginDir))
-          .map(dir => URI.joinPath(pluginDir, dir));
-        return [
-          ...acc,
-          ...content.filter(c => fs.statSync(URI.toFsPath(c)).isDirectory()),
-        ];
-      } catch {
-        return acc;
-      }
-    }, [] as URI[]);
-}
-
-function validate(plugin: any): FoamPlugin {
-  if (!plugin.name) {
-    throw new Error('Plugin must export `name` string property');
-  }
-  return plugin;
-}

packages/foam-core/src/utils/hashtags.ts

@@ -1,16 +0,0 @@
-import { isSome } from './core';
-const HASHTAG_REGEX = /(^|\s)#([0-9]*[\p{L}_-][\p{L}\p{N}_-]*)/gmu;
-const WORD_REGEX = /(^|\s)([0-9]*[\p{L}_-][\p{L}\p{N}_-]*)/gmu;
-
-export const extractHashtags = (text: string): Set<string> => {
-  return isSome(text)
-    ? new Set(Array.from(text.matchAll(HASHTAG_REGEX), m => m[2].trim()))
-    : new Set();
-};
-
-export const extractTagsFromProp = (prop: string | string[]): Set<string> => {
-  const text = Array.isArray(prop) ? prop.join(' ') : prop;
-  return isSome(text)
-    ? new Set(Array.from(text.matchAll(WORD_REGEX)).map(m => m[2].trim()))
-    : new Set();
-};

packages/foam-core/src/utils/slug.ts

@@ -1,5 +0,0 @@
-import GithubSlugger from 'github-slugger';
-import { URI } from '../model/uri';
-
-export const uriToSlug = (uri: URI): string =>
-  GithubSlugger.slug(URI.getBasename(uri));

packages/foam-core/test/config.test.ts

@@ -1,44 +0,0 @@
-import { createConfigFromFolders } from '../src/config';
-import { Logger } from '../src/utils/log';
-import { URI } from '../src/model/uri';
-
-Logger.setLevel('error');
-
-const testFolder = URI.joinPath(URI.file(__dirname), 'test-config');
-
-describe('Foam configuration', () => {
-  it('can read settings from config.json', () => {
-    const config = createConfigFromFolders([
-      URI.joinPath(testFolder, 'folder1'),
-    ]);
-    expect(config.get('feature1.setting1.value')).toBeTruthy();
-    expect(config.get('feature2.value')).toEqual(12);
-
-    const section = config.get<{ value: boolean }>('feature1.setting1');
-    expect(section!.value).toBeTruthy();
-  });
-
-  it('can merge settings from multiple foam folders', () => {
-    const config = createConfigFromFolders([
-      URI.joinPath(testFolder, 'folder1'),
-      URI.joinPath(testFolder, 'folder2'),
-    ]);
-
-    // override value
-    expect(config.get('feature1.setting1.value')).toBe(false);
-    // this was not overridden
-    expect(config.get('feature1.setting1.extraValue')).toEqual('go foam');
-    // new value from second config file
-    expect(config.get('feature1.setting1.value2')).toBe('hello');
-
-    // this whole section doesn't exist in second file
-    expect(config.get('feature2.value')).toEqual(12);
-  });
-
-  it('cannot activate local plugins from workspace config', () => {
-    const config = createConfigFromFolders([
-      URI.joinPath(testFolder, 'enable-plugins'),
-    ]);
-    expect(config.get('experimental.localPlugins.enabled')).toBeUndefined();
-  });
-});

packages/foam-core/test/core.test.ts

@@ -1,94 +0,0 @@
-import path from 'path';
-import { FoamWorkspace } from '../src';
-import { NoteLinkDefinition, Resource } from '../src/model/note';
-import { IDataStore, Matcher } from '../src/services/datastore';
-import { MarkdownResourceProvider } from '../src/markdown-provider';
-import { Range } from '../src/model/range';
-import { URI } from '../src/model/uri';
-import { Logger } from '../src/utils/log';
-
-Logger.setLevel('error');
-
-const position = Range.create(0, 0, 0, 100);
-
-const documentStart = position.start;
-const documentEnd = position.end;
-const eol = '\n';
-
-/**
- * Turns a string into a URI
- * The goal of this function is to make sure we are consistent in the
- * way we generate URIs (and therefore IDs) across the tests
- */
-export const strToUri = URI.file;
-
-export const noOpDataStore = (): IDataStore => ({
-  read: _ => Promise.resolve(''),
-  list: _ => Promise.resolve([]),
-});
-
-export const createTestWorkspace = () => {
-  const workspace = new FoamWorkspace();
-  const matcher = new Matcher([URI.file('/')], ['**/*']);
-  const provider = new MarkdownResourceProvider(
-    matcher,
-    undefined,
-    undefined,
-    noOpDataStore()
-  );
-  workspace.registerProvider(provider);
-  return workspace;
-};
-
-export const createTestNote = (params: {
-  uri: string;
-  title?: string;
-  definitions?: NoteLinkDefinition[];
-  links?: Array<{ slug: string } | { to: string }>;
-  text?: string;
-  root?: URI;
-}): Resource => {
-  const root = params.root ?? URI.file('/');
-  return {
-    uri: URI.resolve(params.uri, root),
-    type: 'note',
-    properties: {},
-    title: params.title ?? path.parse(strToUri(params.uri).path).base,
-    definitions: params.definitions ?? [],
-    tags: new Set(),
-    links: params.links
-      ? params.links.map((link, index) => {
-          const range = Range.create(
-            position.start.line + index,
-            position.start.character,
-            position.start.line + index,
-            position.end.character
-          );
-          return 'slug' in link
-            ? {
-                type: 'wikilink',
-                slug: link.slug,
-                target: link.slug,
-                range: range,
-                text: 'link text',
-              }
-            : {
-                type: 'link',
-                target: link.to,
-                label: 'link text',
-                range: range,
-              };
-        })
-      : [],
-    source: {
-      eol: eol,
-      end: documentEnd,
-      contentStart: documentStart,
-      text: params.text ?? '',
-    },
-  };
-};
-
-describe('Test utils', () => {
-  it('are happy', () => {});
-});

packages/foam-core/test/markdown-provider.test.ts

@@ -1,349 +0,0 @@
-import {
-  createMarkdownParser,
-  createMarkdownReferences,
-} from '../src/markdown-provider';
-import { DirectLink } from '../src/model/note';
-import { ParserPlugin } from '../src/plugins';
-import { Logger } from '../src/utils/log';
-import { uriToSlug } from '../src/utils/slug';
-import { URI } from '../src/model/uri';
-import { FoamGraph } from '../src/model/graph';
-import { createTestWorkspace } from './core.test';
-
-Logger.setLevel('error');
-
-const pageA = `
-# Page A
-
-## Section
-- [[page-b]]
-- [[page-c]]
-- [[Page D]]
-- [[page e]]
-`;
-
-const pageB = `
-# Page B
-
-This references [[page-a]]`;
-
-const pageC = `
-# Page C
-`;
-
-const pageD = `
-# Page D
-`;
-
-const pageE = `
-# Page E
-`;
-
-const createNoteFromMarkdown = (path: string, content: string) =>
-  createMarkdownParser([]).parse(URI.file(path), content);
-
-describe('Markdown loader', () => {
-  it('Converts markdown to notes', () => {
-    const workspace = createTestWorkspace();
-    workspace.set(createNoteFromMarkdown('/page-a.md', pageA));
-    workspace.set(createNoteFromMarkdown('/page-b.md', pageB));
-    workspace.set(createNoteFromMarkdown('/page-c.md', pageC));
-    workspace.set(createNoteFromMarkdown('/page-d.md', pageD));
-    workspace.set(createNoteFromMarkdown('/page-e.md', pageE));
-
-    expect(
-      workspace
-        .list()
-        .map(n => n.uri)
-        .map(uriToSlug)
-        .sort()
-    ).toEqual(['page-a', 'page-b', 'page-c', 'page-d', 'page-e']);
-  });
-
-  it('Ingores external links', () => {
-    const note = createNoteFromMarkdown(
-      '/path/to/page-a.md',
-      `
-this is a [link to google](https://www.google.com)
-`
-    );
-    expect(note.links.length).toEqual(0);
-  });
-
-  it('Ignores references to sections in the same file', () => {
-    const note = createNoteFromMarkdown(
-      '/path/to/page-a.md',
-      `
-this is a [link to intro](#introduction)
-`
-    );
-    expect(note.links.length).toEqual(0);
-  });
-
-  it('Parses internal links correctly', () => {
-    const note = createNoteFromMarkdown(
-      '/path/to/page-a.md',
-      'this is a [link to page b](../doc/page-b.md)'
-    );
-    expect(note.links.length).toEqual(1);
-    const link = note.links[0] as DirectLink;
-    expect(link.type).toEqual('link');
-    expect(link.label).toEqual('link to page b');
-    expect(link.target).toEqual('../doc/page-b.md');
-  });
-
-  it('Parses links that have formatting in label', () => {
-    const note = createNoteFromMarkdown(
-      '/path/to/page-a.md',
-      'this is [**link** with __formatting__](../doc/page-b.md)'
-    );
-    expect(note.links.length).toEqual(1);
-    const link = note.links[0] as DirectLink;
-    expect(link.type).toEqual('link');
-    expect(link.label).toEqual('link with formatting');
-    expect(link.target).toEqual('../doc/page-b.md');
-  });
-
-  it('Parses wikilinks correctly', () => {
-    const workspace = createTestWorkspace();
-    const noteA = createNoteFromMarkdown('/page-a.md', pageA);
-    const noteB = createNoteFromMarkdown('/page-b.md', pageB);
-    const noteC = createNoteFromMarkdown('/page-c.md', pageC);
-    const noteD = createNoteFromMarkdown('/Page D.md', pageD);
-    const noteE = createNoteFromMarkdown('/page e.md', pageE);
-
-    workspace
-      .set(noteA)
-      .set(noteB)
-      .set(noteC)
-      .set(noteD)
-      .set(noteE);
-    const graph = FoamGraph.fromWorkspace(workspace);
-
-    expect(graph.getBacklinks(noteB.uri).map(l => l.source)).toEqual([
-      noteA.uri,
-    ]);
-    expect(graph.getLinks(noteA.uri).map(l => l.target)).toEqual([
-      noteB.uri,
-      noteC.uri,
-      noteD.uri,
-      noteE.uri,
-    ]);
-  });
-});
-
-describe('Note Title', () => {
-  it('should initialize note title if heading exists', () => {
-    const note = createNoteFromMarkdown(
-      '/page-a.md',
-      `
-# Page A
-this note has a title
-    `
-    );
-    expect(note.title).toBe('Page A');
-  });
-
-  it('should default to file name if heading does not exist', () => {
-    const note = createNoteFromMarkdown(
-      '/page-d.md',
-      `
-This file has no heading.
-      `
-    );
-
-    expect(note.title).toEqual('page-d');
-  });
-
-  it('should give precedence to frontmatter title over other headings', () => {
-    const note = createNoteFromMarkdown(
-      '/page-e.md',
-      `
----
-title: Note Title
-date: 20-12-12
----
-
-# Other Note Title
-      `
-    );
-
-    expect(note.title).toBe('Note Title');
-  });
-
-  it('should not break on empty titles (see #276)', () => {
-    const note = createNoteFromMarkdown(
-      '/Hello Page.md',
-      `
-#
-
-this note has an empty title line
-    `
-    );
-    expect(note.title).toEqual('Hello Page');
-  });
-});
-
-describe('frontmatter', () => {
-  it('should parse yaml frontmatter', () => {
-    const note = createNoteFromMarkdown(
-      '/page-e.md',
-      `
----
-title: Note Title
-date: 20-12-12
----
-
-# Other Note Title`
-    );
-
-    expect(note.properties.title).toBe('Note Title');
-    expect(note.properties.date).toBe('20-12-12');
-  });
-
-  it('should parse empty frontmatter', () => {
-    const note = createNoteFromMarkdown(
-      '/page-f.md',
-      `
----
----
-
-# Empty Frontmatter
-`
-    );
-
-    expect(note.properties).toEqual({});
-  });
-
-  it('should not fail when there are issues with parsing frontmatter', () => {
-    const note = createNoteFromMarkdown(
-      '/page-f.md',
-      `
----
-title: - one
- - two
- - #
----
-
-`
-    );
-
-    expect(note.properties).toEqual({});
-  });
-});
-
-describe('wikilinks definitions', () => {
-  it('can generate links without file extension when includeExtension = false', () => {
-    const workspace = createTestWorkspace();
-    const noteA = createNoteFromMarkdown('/dir1/page-a.md', pageA);
-    workspace
-      .set(noteA)
-      .set(createNoteFromMarkdown('/dir1/page-b.md', pageB))
-      .set(createNoteFromMarkdown('/dir1/page-c.md', pageC));
-
-    const noExtRefs = createMarkdownReferences(workspace, noteA.uri, false);
-    expect(noExtRefs.map(r => r.url)).toEqual(['page-b', 'page-c']);
-  });
-
-  it('can generate links with file extension when includeExtension = true', () => {
-    const workspace = createTestWorkspace();
-    const noteA = createNoteFromMarkdown('/dir1/page-a.md', pageA);
-    workspace
-      .set(noteA)
-      .set(createNoteFromMarkdown('/dir1/page-b.md', pageB))
-      .set(createNoteFromMarkdown('/dir1/page-c.md', pageC));
-
-    const extRefs = createMarkdownReferences(workspace, noteA.uri, true);
-    expect(extRefs.map(r => r.url)).toEqual(['page-b.md', 'page-c.md']);
-  });
-
-  it('use relative paths', () => {
-    const workspace = createTestWorkspace();
-    const noteA = createNoteFromMarkdown('/dir1/page-a.md', pageA);
-    workspace
-      .set(noteA)
-      .set(createNoteFromMarkdown('/dir2/page-b.md', pageB))
-      .set(createNoteFromMarkdown('/dir3/page-c.md', pageC));
-
-    const extRefs = createMarkdownReferences(workspace, noteA.uri, true);
-    expect(extRefs.map(r => r.url)).toEqual([
-      '../dir2/page-b.md',
-      '../dir3/page-c.md',
-    ]);
-  });
-});
-
-describe('tags plugin', () => {
-  it('can find tags in the text of the note', () => {
-    const noteA = createNoteFromMarkdown(
-      '/dir1/page-a.md',
-      `
-# this is a heading
-this is some #text that includes #tags we #care-about.
-    `
-    );
-    expect(noteA.tags).toEqual(new Set(['text', 'tags', 'care-about']));
-  });
-
-  it('can find tags as text in yaml', () => {
-    const noteA = createNoteFromMarkdown(
-      '/dir1/page-a.md',
-      `
----
-tags: hello, world  this_is_good
----
-# this is a heading
-this is some #text that includes #tags we #care-about.
-    `
-    );
-    expect(noteA.tags).toEqual(
-      new Set(['text', 'tags', 'care-about', 'hello', 'world', 'this_is_good'])
-    );
-  });
-
-  it('can find tags as array in yaml', () => {
-    const noteA = createNoteFromMarkdown(
-      '/dir1/page-a.md',
-      `
----
-tags: [hello, world,  this_is_good]
----
-# this is a heading
-this is some #text that includes #tags we #care-about.
-    `
-    );
-    expect(noteA.tags).toEqual(
-      new Set(['text', 'tags', 'care-about', 'hello', 'world', 'this_is_good'])
-    );
-  });
-});
-
-describe('parser plugins', () => {
-  const testPlugin: ParserPlugin = {
-    visit: (node, note) => {
-      if (node.type === 'heading') {
-        note.properties.hasHeading = true;
-      }
-    },
-  };
-  const parser = createMarkdownParser([testPlugin]);
-
-  it('can augment the parsing of the file', () => {
-    const note1 = parser.parse(
-      URI.file('/path/to/a'),
-      `
-This is a test note without headings.
-But with some content.
-`
-    );
-    expect(note1.properties.hasHeading).toBeUndefined();
-
-    const note2 = parser.parse(
-      URI.file('/path/to/a'),
-      `
-# This is a note with header
-and some content`
-    );
-    expect(note2.properties.hasHeading).toBeTruthy();
-  });
-});

packages/foam-core/test/plugin.test.ts

@@ -1,63 +0,0 @@
-import path from 'path';
-import { loadPlugins } from '../src/plugins';
-import { createMarkdownParser } from '../src/markdown-provider';
-import { FoamConfig, createConfigFromObject } from '../src/config';
-import { URI } from '../src/model/uri';
-import { Logger } from '../src/utils/log';
-
-Logger.setLevel('error');
-
-const config: FoamConfig = createConfigFromObject([], [], [], {
-  experimental: {
-    localPlugins: {
-      enabled: true,
-      pluginFolders: [path.join(__dirname, 'test-plugin')],
-    },
-  },
-});
-
-describe('Foam plugins', () => {
-  it('will not load if feature is not explicitly enabled', async () => {
-    let plugins = await loadPlugins(createConfigFromObject([], [], [], {}));
-    expect(plugins.length).toEqual(0);
-    plugins = await loadPlugins(
-      createConfigFromObject([], [], [], {
-        experimental: {
-          localPlugins: {},
-        },
-      })
-    );
-    expect(plugins.length).toEqual(0);
-    plugins = await loadPlugins(
-      createConfigFromObject([], [], [], {
-        experimental: {
-          localPlugins: {
-            enabled: false,
-          },
-        },
-      })
-    );
-    expect(plugins.length).toEqual(0);
-  });
-
-  it('can load', async () => {
-    const plugins = await loadPlugins(config);
-    expect(plugins.length).toEqual(1);
-    expect(plugins[0].name).toEqual('Test Plugin');
-  });
-
-  it('supports parser extension', async () => {
-    const plugins = await loadPlugins(config);
-    const parserPlugin = plugins[0].parser;
-    expect(parserPlugin).not.toBeUndefined();
-    const parser = createMarkdownParser([parserPlugin!]);
-
-    const note = parser.parse(
-      URI.file('/path/to/a'),
-      `
-# This is a note with header
-and some content`
-    );
-    expect(note.properties.hasHeading).toBeTruthy();
-  });
-});

packages/foam-core/test/test-plugin/index.js

@@ -1,20 +0,0 @@
-const middleware = next => ({
-  setNote: note => {
-    note.properties['injectedByMiddleware'] = true;
-    return next.setNote(note);
-  },
-});
-
-const parser = {
-  visit: (node, note) => {
-    if (node.type === 'heading') {
-      note.properties.hasHeading = true;
-    }
-  },
-};
-
-module.exports = {
-  name: 'Test Plugin',
-  graphMiddleware: middleware,
-  parser: parser,
-};

packages/foam-core/test/uri.test.ts

@@ -1,48 +0,0 @@
-import { URI } from '../src/model/uri';
-import { uriToSlug } from '../src/utils/slug';
-
-describe('Foam URIs', () => {
-  describe('URI parsing', () => {
-    const base = URI.file('/path/to/file.md');
-    test.each([
-      ['https://www.google.com', URI.parse('https://www.google.com')],
-      ['/path/to/a/file.md', URI.file('/path/to/a/file.md')],
-      ['../relative/file.md', URI.file('/path/relative/file.md')],
-      ['#section', URI.create({ ...base, fragment: 'section' })],
-      [
-        '../relative/file.md#section',
-        URI.parse('file:/path/relative/file.md#section'),
-      ],
-    ])('URI Parsing (%s) - %s', (input, exp) => {
-      const result = URI.resolve(input, base);
-      expect(result.scheme).toEqual(exp.scheme);
-      expect(result.authority).toEqual(exp.authority);
-      expect(result.path).toEqual(exp.path);
-      expect(result.query).toEqual(exp.query);
-      expect(result.fragment).toEqual(exp.fragment);
-    });
-  });
-  it('supports various cases', () => {
-    expect(uriToSlug(URI.file('/this/is/a/path.md'))).toEqual('path');
-    expect(uriToSlug(URI.file('../a/relative/path.md'))).toEqual('path');
-    expect(uriToSlug(URI.file('another/relative/path.md'))).toEqual('path');
-    expect(uriToSlug(URI.file('no-directory.markdown'))).toEqual(
-      'no-directory'
-    );
-    expect(uriToSlug(URI.file('many.dots.name.markdown'))).toEqual(
-      'manydotsname'
-    );
-  });
-
-  it('computes a relative uri using a slug', () => {
-    expect(
-      URI.computeRelativeURI(URI.file('/my/file.md'), '../hello.md')
-    ).toEqual(URI.file('/hello.md'));
-    expect(URI.computeRelativeURI(URI.file('/my/file.md'), '../hello')).toEqual(
-      URI.file('/hello.md')
-    );
-    expect(
-      URI.computeRelativeURI(URI.file('/my/file.markdown'), '../hello')
-    ).toEqual(URI.file('/hello.markdown'));
-  });
-});

packages/foam-core/test/utils.test.ts

@@ -1,57 +0,0 @@
-import { extractHashtags } from '../src/utils';
-import { Logger } from '../src/utils/log';
-
-Logger.setLevel('error');
-
-describe('hashtag extraction', () => {
-  it('works with simple strings', () => {
-    expect(extractHashtags('hello #world on #this planet')).toEqual(
-      new Set(['world', 'this'])
-    );
-  });
-  it('works with tags at beginning or end of text', () => {
-    expect(extractHashtags('#hello world on this #planet')).toEqual(
-      new Set(['hello', 'planet'])
-    );
-  });
-  it('supports _ and -', () => {
-    expect(extractHashtags('#hello-world on #this_planet')).toEqual(
-      new Set(['hello-world', 'this_planet'])
-    );
-  });
-  it('ignores tags that only have numbers in text', () => {
-    expect(
-      extractHashtags('this #123 tag should be ignore, but not #123four')
-    ).toEqual(new Set(['123four']));
-  });
-  it('supports unicode letters like Chinese charaters', () => {
-    expect(
-      extractHashtags(`
-        this #tag_with_unicode_letters_汉字, pure Chinese tag like #纯中文标签 and 
-        other mixed tags like #标签1 #123四 should work
-      `)
-    ).toEqual(
-      new Set(['tag_with_unicode_letters_汉字', '纯中文标签', '标签1', '123四'])
-    );
-  });
-
-  it('ignores hashes in plain text urls and links', () => {
-    expect(
-      extractHashtags(`
-        test text with url https://site.com/#section1 https://site.com/home#section2 and
-        https://site.com/home/#section3a
-        [link](https://site.com/#section4) with [link2](https://site.com/home#section5) #control
-        hello world
-      `)
-    ).toEqual(new Set(['control']));
-  });
-
-  it('ignores hashes in links to sections', () => {
-    expect(
-      extractHashtags(`
-      this is a wikilink to [[#section1]] in the file and a [[link#section2]] in another
-      this is a [link](#section3) to a section
-      `)
-    ).toEqual(new Set());
-  });
-});

packages/foam-core/tsconfig.build.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "module": "ESNext"
-  }
-}

packages/foam-core/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": "src",
-    "composite": true,
-    "esModuleInterop": true,
-    "importHelpers": true,
-    "downlevelIteration": true,
-    // commonjs module format is used so that the incremental
-    // tsc build-mode ran during development can replace individual
-    // files (as opposed to generate the .cjs.development.js bundle.
-    //
-    // this is overridden in tsconfig.build.json for distribution
-    "module": "commonjs",
-
-    "moduleResolution": "node",
-    "outDir": "dist",
-    "rootDir": "./src",
-    "sourceMap": true,
-    "strict": true,
-    "lib": [
-      "ES2019", "es2020.string"
-    ]
-  },
-  "include": [
-    "src",
-    "types"
-  ]
-}

packages/foam-vscode/CHANGELOG.md

@@ -4,12 +4,280 @@ All notable changes to the "foam-vscode" extension will be documented in this fi
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
+## [0.18.1] - 2022-04-13
+
+Fixes and Improvements:
+- Fixed parsing error for direct links with square brackets in them (#977)
+- Improved markdown direct link resolution (#972)
+- Improved templates support for custom paths (#970)
+
+## [0.18.0] - 2022-04-11
+
+Features:
+- Link synchronization on file rename
+
+Internal:
+- Changed graph computation on workspace change to simplify code
+
+## [0.17.8] - 2022-04-01
+
+Fixes and Improvements:
+- Do not add ignored files to Foam upon change (#480)
+- Restore full use of editor.action.openLink (#693)
+- Minor performance improvements
+
+## [0.17.7] - 2022-03-29
+
+Fixes and Improvements:
+- Include links with sections in backlinks (#895)
+- Improved navigation when document editor is already open
+
+## [0.17.6] - 2022-03-03
+
+Fixes and Improvements:
+- Don't fail on error when scannig workspace (#943 - thanks @develmusa)
+
+## [0.17.5] - 2022-02-22
+
+Fixes and Improvements:
+- Added FOAM_SLUG template variable (#865 - Thanks @techCarpenter)
+
+## [0.17.4] - 2022-02-13
+
+Fixes and Improvements:
+- Improvements to Foam variables in templates (#882 - thanks @movermeyer)
+  - Foam variables can now be used just any other VS Code variables, including in combination with placeholders and transformers
+
+## [0.17.3] - 2022-01-14
+
+Fixes and Improvements:
+- Fixed autocompletion with tags (#885 - thanks @memeplex)
+- Improved "Open Daily Note" to be usabled in tasks (#897 - thanks @MCluck90)
+
+## [0.17.2] - 2021-12-22
+
+Fixes and Improvements:
+- Improved support for wikilinks in titles (#878)
+- Use syntax injection for wikilinks (#876 - thanks @memeplex)
+- Fix when applying text edits in last line 
+
+Internal:
+- DX: Clean up of testing setup (#881 - thanks @memeplex)
+
+## [0.17.1] - 2021-12-16
+
+Fixes and Improvements:
+- Decorate markdown files only (#857)
+- Fix template placeholders issue (#859)
+- Improved replacement range for link completion
+
+Internal:
+- Major URI/path handling refactoring (#858 - thanks @memeplex)
+
+## [0.17.0] - 2021-12-08
+
+Features:
+
+- Added first class support for sections (#856)
+  - Sections can be referred to in wikilinks
+  - Sections can be embedded
+  - Autocompletion for sections
+  - Diagnostic for sections
+  - Embed sections
+
+## [0.16.1] - 2021-11-30
+
+Fixes and Improvements:
+
+- Fixed diagnostic bug triggered when file had same suffix (#851)
+
+## [0.16.0] - 2021-11-24
+
+Features:
+
+- Added support for unique wikilink identifiers (#841)
+  - This change allows files that have the same name to be uniquely referenced as wikilinks
+  - BREAKING CHANGE: wikilinks to attachments must now include the extension
+- Added diagnostics for ambiguous wikilinks, with quick fixes available (#844)
+- Added support for unique wikilinks in autocompletion (#845)
+
+## [0.15.9] - 2021-11-23
+
+Fixes and Improvements:
+
+- Fixed filepath retrieval when creating note from template (#843)
+
+## [0.15.8] - 2021-11-22
+
+Fixes and Improvements:
+
+- Re-enable link navigation for wikilinks (#840)
+
+## [0.15.7] - 2021-11-21
+
+Fixes and Improvements:
+
+- Fixed template listing (#831)
+- Fixed note creation from template (#834)
+
+## [0.15.6] - 2021-11-18
+
+Fixes and Improvements:
+
+- Link Reference Generation is now OFF by default
+- Fixed preview navigation (#830)
+
+
+## [0.15.5] - 2021-11-15
+
+Fixes and Improvements:
+
+- Major improvement in navigation. Use link definitions and link references (#821)
+- Fixed bug showing in hover reference the same more than once when it had multiple links to another (#822)
+
+Internal:
+
+- Foam URI refactoring (#820)
+- Template service refactoring (#825)
+
+## [0.15.4] - 2021-11-09
+
+Fixes and Improvements:
+
+- Detached Foam URI from VS Code URI. This should improve several path related issues in Windows. Given how core this change is, the release is just about this refactoring to easily detect possible side effects.
+
+## [0.15.3] - 2021-11-08
+
+Fixes and Improvements:
+
+- Avoid delaying decorations on editor switch (#811 - thanks @memeplex)
+- Fix preview issue when embedding a note and using reference definitions (#808 - thanks @pderaaij)
+
+## [0.15.2] - 2021-10-27
+
+Features:
+
+- Added `FOAM_DATE_*` template variables (#781)
+
+Fixes and Improvements:
+
+- Dataviz: apply note type color to filter item label
+- Dataviz: optimized rendering of graph to reduce load on CPU (#795)
+- Preview: improved tag highlight in preview (#785 - thanks @pderaaij)
+- Better handling of link reference definition (#786 - thanks @pderaaij)
+- Link decorations are now enabled by default (can be turned off in settings)
+
+## [0.15.1] - 2021-10-21
+
+Fixes and Improvements:
+
+- Improved filtering controls for graph (#782)
+- Link Hover: Include other connected notes to link target
+
+## [0.15.0] - 2021-10-04
+
+Features:
+
+- Preview on hover for wikilinks (#728 - thanks @JonasSprenger)
+- Added tags and controls to graph dataviz (#737 - thanks @dannysemi)
+
+Fixes and Improvements:
+
+- Improved tags parsing (#708 - thanks @pderaaij)
+- Fixed support for resources named like JS Object methods (#729 - thanks @JonasSprenger)
+
+## [0.14.2] - 2021-07-24
+
+Features:
+
+- Autocompletion for tags (#708 - thanks @pderaaij)
+- Use templates for new note created from wikilink (#712 - thanks @movermeyer)
+
+Fixes and Improvements:
+
+- Improved performance of initial file loading (#730 - thanks @pderaaij)
+
+## [0.14.1] - 2021-07-14
+
+Fixes and Improvements:
+
+- Fixed NPE that would cause markdown preview to render incorrectly (#718 - thanks @pderaaij)
+
+## [0.14.0] - 2021-07-13
+
+Features:
+
+- Create new note from selection (#666 - thanks @pderaaij)
+- Use templates for daily notes (#700 - thanks @movermeyer)
+
+Fixes and Improvements:
+
+- Fixed for wikilink aliases in tables (#697 - thanks @pderaaij)
+- Fixed link definition generation in presence of aliased wikilinks (#698 - thanks @pderaaij)
+- Fixed template insertion of selected text (#701 - thanks @movermeyer)
+- Fixed preview navigation (#710 - thanks @pderaaij)
+
+## [0.13.8] - 2021-07-02
+
+Fixes and Improvements:
+
+- Improved handling of capitalization in wikilinks (#688 - thanks @pderaaij)
+  - This update will make wikilinks with different capitalization, such as `[[wikilink]]` and `[[WikiLink]]` point to the same file. Please note that means that files that only differ in capitalization across the workspace would now be treated as having the same name
+- Allow dots in wikilinks (#689 - thanks @pderaaij)
+- Fixed a bug in the expansion of date snippets (thanks @syndenham-chorea)
+- Added support for wikilink alias syntax, like `[[wikilink|label]]` (#689 - thanks @pderaaij)
+
+## [0.13.7] - 2021-06-05
+
+Fixes and Improvements:
+
+- Fixed #667, incorrect resolution of foam-core library
+
+Internal:
+
+- BREAKING CHANGE: Removed Foam local plugins
+  If you were previously using the alpha feature of Foam local plugins you will soon be able to migrate the functionality to the V1 API
+
+## [0.13.6] - 2021-06-05
+
+Fixes and Improvements:
+
+- Fixed #667, incorrect resolution of foam-core library
+
+## [0.13.5] - 2021-06-05
+
+Fixes and Improvements:
+
+- Improved support for nested tags (#661 - thanks @pderaaij)
+- Allow YAML metadata in templates (#655 - thanks @movermeyer)
+- Fixed template exclusion globs (#665)
+
+## [0.13.4] - 2021-05-26
+
+Fixes and Improvements:
+
+- Added support for nested tags (#643 - thanks @pderaaij)
+- Improved the flow of creating note from template (#645 - thanks @movermeyer)
+- Fixed handling of title property in YAML (#647 - thanks @pderaaij and #546)
+
+Internal:
+
+- Updated various dependencies
+
+## [0.13.3] - 2021-05-09
+
+Fixes and Improvements:
+
+- Improved Foam template variables resolution: unknown variables are now ignored (#622 - thanks @movermeyer)
+- Fixed file matching in MarkdownProvider (#617)
+- Fixed cancelling `Foam: Create New Note` and `Foam: Create New Note From Template` behavior (#623 - thanks @movermeyer)
+
 ## [0.13.2] - 2021-05-06
 
 Fixes and Improvements:
 
 - Fixed wikilink completion bug (#592 - thanks @RobinKing)
-- Added support for stylable tags (#598 - thanks @Barabas)
+- Added support for stylable tags (#598 - thanks @Barabazs)
 - Added "Create new note" command (#601 - thanks @movermeyer)
 - Fixed navigation from placeholder and orphan panel (#600)
 

packages/foam-vscode/README.md

@@ -5,15 +5,133 @@
 [![Installs](https://img.shields.io/visual-studio-marketplace/i/foam.foam-vscode)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
 [![Ratings](https://img.shields.io/visual-studio-marketplace/r/foam.foam-vscode)](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
 
-> ⚠️ This is an early stage software. Use at your own peril.
 > You can join the Foam Community on the [Foam Discord](https://foambubble.github.io/join-discord/e)
 
-[Foam](https://foambubble.github.io/foam) is a note-taking tool that lives within VsCode, which means you can pair it with your favorite extensions for a great editing experience.
+[Foam](https://foambubble.github.io/foam) is a note-taking tool that lives within VS Code, which means you can pair it with your favorite extensions for a great editing experience.
 
 Foam is open source, and allows you to create a local first, markdown based, personal knowledge base. You can also use it to publish your notes.
 
 Foam is also meant to be extensible, so you can integrate with its internals to customize your knowledge base.
 
+## Features
+
+### Graph Visualization
+
+See how your notes are connected via a [graph](https://foambubble.github.io/foam/features/graph-visualisation) with the `Foam: Show Graph` command.
+
+![Graph Visualization](./assets/screenshots/feature-show-graph.gif)
+
+### Link Autocompletion
+
+Foam helps you create the connections between your notes, and your placeholders as well.
+
+![Link Autocompletion](./assets/screenshots/feature-link-autocompletion.gif)
+
+### Sync links on file rename
+
+Foam updates the links to renamed files, so your notes stay consistent.
+
+![Sync links on file rename](./assets/screenshots/feature-link-sync.gif)
+
+### Unique identifiers across directories
+
+Foam supports files with the same name in multiple directories.
+It will use the minimum identifier required, and even report and help you fix existing ambiguous wikilinks.
+
+![Unique identifier autocompletion](./assets/screenshots/feature-unique-wikilink-completion.gif)
+
+![Wikilink diagnostic](./assets/screenshots/feature-wikilink-diagnostics.gif)
+
+### Link Preview and Navigation
+
+![Link Preview and Navigation](./assets/screenshots/feature-navigation.gif)
+
+### Go to definition, Peek References
+
+See where a note is being referenced in your knowledge base.
+
+![Go to Definition, Peek References](./assets/screenshots/feature-definition-references.gif)
+
+### Navigation in Preview
+
+Navigate your rendered notes in the VS Code preview panel.
+
+![Navigation in Preview](./assets/screenshots/feature-preview-navigation.gif)
+
+### Note embed
+
+Embed the content from other notes.
+
+![Note Embed](./assets/screenshots/feature-note-embed.gif)
+
+### Support for sections
+
+Foam supports autocompletion, navigation, embedding and diagnostics for note sections.
+Just use the standard wiki syntax of `[[resource#Section Title]]`.
+
+### Link Alias
+
+Foam supports link aliasing, so you can have a `[[wikilink]]`, or a `[[wikilink|alias]]`.
+
+### Templates
+
+Use [custom templates](https://foambubble.github.io/foam/features/note-templates) to have avoid repetitve work on your notes.
+
+![Templates](./assets/screenshots/feature-templates.gif)
+
+### Backlinks Panel
+
+Quickly check which notes are referencing the currently active note.
+See for each occurrence the context in which it lives, as well as a preview of the note.
+
+![Backlinks Panel](./assets/screenshots/feature-backlinks-panel.gif)
+
+### Tag Explorer Panel
+
+Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/features/tags).
+Foam also supports hierarchical tags.
+
+![Tag Explorer Panel](./assets/screenshots/feature-tags-panel.gif)
+
+### Orphans and Placeholder Panels
+
+Orphans are note that have no inbound nor outbound links. 
+Placeholders are dangling links, or notes without content.
+Keep them under control, and your knowledge base in better state, by using this panel.
+
+![Orphans and Placeholder Panels](./assets/screenshots/feature-placeholder-orphan-panel.gif)
+
+### Syntax highlight
+
+Foam highlights wikilinks and placeholder differently, to help you visualize your knowledge base.
+
+![Syntax Highlight](./assets/screenshots/feature-syntax-highlight.png)
+
+### Daily note
+
+Create a journal with [daily notes](https://foambubble.github.io/foam/features/daily-notes).
+
+![Daily Note](./assets/screenshots/feature-daily-note.gif)
+
+### Generate references for your wikilinks
+
+Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wikilinks]]`, to use your notes in a non-Foam workspace.
+With references you can also make your notes navigable both in GitHub UI as well as GitHub Pages.
+
+![Generate references](./assets/screenshots/feature-definitions-generation.gif)
+
+### Commands
+
+- Explore your knowledge base with the `Foam: Open Random Note` command
+- Access your daily note with the `Foam: Open Daily Note` command
+- Create a new note with the `Foam: Create New Note` command
+  - This becomes very powerful when combined with [note templates](https://foambubble.github.io/foam/features/note-templates) and the `Foam: Create New Note from Template` command
+- See your workspace as a connected graph with the `Foam: Show Graph` command
+
+## Recipes
+
+People use Foam in different ways for different use cases, check out the [recipes](https://foambubble.github.io/foam/recipes/recipes) page for inspiration!
+
 ## Getting started
 
 You really, _really_, **really** should read [Foam documentation](https://foambubble.github.io/foam), but if you can't be bothered, this is how to get started:
@@ -22,24 +140,13 @@ You really, _really_, **really** should read [Foam documentation](https://foambu
 2. Clone the repository and open it in VS Code.
 3. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one).
 
-This will also install `Foam for VSCode`, but if you already have it installed, that's ok, just make sure you're up to date on the latest version.
-
-You really, _really_, **really** should read [Foam documentation](https://foambubble.github.io/foam), but if you can't be bothered, this is how to get started:
-
-## Features
-
-- Connect your notes using [`[[wiki-links]]`](https://foambubble.github.io/foam/features/backlinking)
-- Create markdown [references](https://foambubble.github.io/foam/features/link-reference-definitions) for `[[wiki-links]]`, to use your notes in a non-foam workspace
-- See how your notes are connected via a [graph](https://foambubble.github.io/foam/features/graph-visualisation) with the `Foam: Show Graph` command
-- Tag your notes and navigate them with the [Tag Explorer](https://foambubble.github.io/foam/features/tags)
-- Make your notes navigable both in GitHub UI as well as GitHub Pages
-- Use [custom templates](https://foambubble.github.io/foam/features/note-templates) for your notes
-- Create a journal with [daily notes](https://foambubble.github.io/foam/features/daily-notes)
-- Explore your knowledge base with the `Foam: Open Random Note` command
+This will also install `Foam`, but if you already have it installed, that's ok, just make sure you're up to date on the latest version.
 
 ## Requirements
 
 High tolerance for alpha-grade software.
+Foam is still a Work in Progress.
+Rest assured it will never lock you in, nor compromise your files, but sometimes some features might break ;)
 
 ## Known Issues