v0.17.5

* docs: update docs/index.md [skip ci]

* docs: update readme.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -661,6 +661,187 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "daniel-vera-g",
+      "name": "Daniel VG",
+      "avatar_url": "https://avatars.githubusercontent.com/u/28257108?v=4",
+      "profile": "https://github.com/daniel-vera-g",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Barabazs",
+      "name": "Barabas",
+      "avatar_url": "https://avatars.githubusercontent.com/u/31799121?v=4",
+      "profile": "https://github.com/Barabazs",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "EngincanV",
+      "name": "Engincan VESKE",
+      "avatar_url": "https://avatars.githubusercontent.com/u/43685404?v=4",
+      "profile": "http://enginveske@gmail.com",
+      "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"
+      ]
     }
   ],
   "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

@@ -20,4 +20,4 @@ labels: bug
 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))
+- the Foam log in VsCode (see [instructions](https://github.com/foambubble/foam/blob/master/docs/features/foam-logging-in-vscode.md))

.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,20 +12,21 @@
   },
   // 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/**/*",
     "**/_site/**/*",
-    "**/node_modules/**/*"
+    "**/node_modules/**/*",
+    "packages/**/*"
   ],
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.requireConfig": true,
-  "editor.formatOnSave": true,
   "editor.tabSize": 2,
-  "jest.debugCodeLens.showWhenTestStateIn": [
-    "fail",
-    "unknown",
-    "pass"
-  ],
-  "gitdoc.enabled": false
+  "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,
+  "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/404.md

@@ -3,9 +3,10 @@
 Well, that shouldn't have happened!
 
 If you got here via a link from another document, please file an [issue](https://github.com/foambubble/foam/issues) on our GitHub repo including:
+
 - the page you came from
 - the link you followed
 
 Thanks!
 
--The Foam Team
+-The Foam Team

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)
@@ -223,7 +223,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rouge (3.23.0)
     ruby-enum (0.8.0)
       i18n

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/big-vision.md

@@ -12,7 +12,6 @@
 - What use cases are we working towards?
   -[[todo]] User round table
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: dev/todo.md "Todo"
-[//end]: # "Autogenerated link references"
+[//end]: # "Autogenerated link references"

docs/code-of-conduct.md

@@ -118,7 +118,7 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
@@ -126,7 +126,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
-
-
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

docs/contribution-guide.md

@@ -2,19 +2,21 @@
 tags: todo, good-first-task
 ---
 # Contribution Guide
+
 Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback.
 This guide aims to help guide new and seasoned contributors getting around the Foam codebase.
 
 ## Getting Up To Speed
+
 Before you start contributing we recommend that you read the following links:
 
 - [[principles]] - This document describes the guiding principles behind Foam.
 - [[code-of-conduct]] - Rules we hope every contributor aims to follow, allowing everyone to participate in our community!
 
 ## Diving In
+
 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)!
@@ -31,36 +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
 
-Also, note that tests in `foam-core` live in the `test` directory.
-Tests in `foam-vscode` live alongside the code in `src`.
+- `*.test.ts` are unit tests
+- `*.spec.ts` are integration tests
+
+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!
@@ -70,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,21 +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/build-vs-assemble.md

@@ -10,5 +10,3 @@ But there's also a bunch of roadmap items that are hard to implement this way, a
 Overall, we should strive to build big things from small things. Focused, interoperable modules are better, because they allow users to pick and mix which features work for them. A good example of why this matters is the Markdown All In One extension we rely on: While it provides many of the things we need, a few of its features are incompatible with how I would like to work, and therefore it becomes a limiter of how well I can improve my own workflow.
 
 However, there becomes a point where we may benefit from implementing a centralised solution, e.g. a syntax, an extension or perhaps a VSCode language server. As much as possible, we should allow users to operate in a decentralised manner.
-
-

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:
 
@@ -72,6 +72,7 @@ The potential solution:
     - This would be a GitHub action (or a local script, ran via foam-cli) that outputs publish-friendly markdown format for static site generators and other publishing tools
     - This build step should be pluggable, so that other transformations could be ran during it
   - Have publish targets defined in settings, that support both turning the link reference definitions on/off and defining their format (.md or not). Example draft (including also edit-time aspect):
+
     ```typescript
     // settings json
     // see enumerations below for explanations on values
@@ -120,8 +121,9 @@ 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).
@@ -135,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/materialized-backlinks.md

@@ -11,8 +11,7 @@ The idea would be to automatically generate lists of backlinks (and optionally,
 - Make every link two-way navigable in published sites
 - Make Foam notes more portable to different apps and long-term storage
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: todo.md "Todo"
 [roadmap]: roadmap.md "Roadmap"
-[//end]: # "Autogenerated link references"
+[//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,12 +1,14 @@
 # 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 `New Note` from [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) and enter a **Title Case Name** to create `title-case-name.md`
+- `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.
+  - The [[note-templates]] used by this command can be customized.
 - You shouldn't worry too much about categorizing your notes. You can always [[search-for-notes]], and explore them using the [[graph-visualisation]].
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[search-for-notes]: ../recipes/search-for-notes.md "Search for Notes"
-[graph-visualisation]: graph-visualisation.md "Graph Visualisation"
+[note-templates]: note-templates "Note Templates"
+[search-for-notes]: ../recipes/search-for-notes "Search for Notes"
+[graph-visualisation]: graph-visualisation "Graph Visualisation"
 [//end]: # "Autogenerated link references"

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/foam-logging-in-vscode.md

@@ -1,19 +1,21 @@
 # Foam logging in VsCode
 
 ## Find the Foam log
+
 The Foam log can be found in the `Output` tab.
+
 1. To show the tab, click on `View > Output`.
 2. In the dropdown on the right of the tab, select `Foam`.
 
 ![Find the foam log](../assets/images/foam-log.png)
 
 ## Change the default logging level
+
 1. Open workspace settings (`cmd+,`, or execute the `Preferences: Open Workspace Settings` command)
 2. Look for the entry `Foam > Logging: Level`
 
 Set to debug when reporting an issue
 
 ## Change the log level for the session
+
 Execute the command `Foam: Set log level`.
-
-

docs/features/graph-visualisation.md

@@ -3,6 +3,7 @@
 Foam comes with a graph visualisation of your notes. To see the graph execute the `Foam: Show Graph` command.
 
 The graph will:
+
 - allow you to highlight a node by hovering on it, to quickly see how it's connected to the rest of your notes
 - allow you to select one or more (by keeping `SHIFT` pressed while selecting) nodes by clicking on them, to better understand the structure of your notes
 - allow you to navigate to a note by clicking on it while pressing `CTRL` or `CMD`
@@ -32,6 +33,7 @@ A sample configuration object is provided below:
 ```
 
 ### Style nodes by type
+
 It is possible to customize the style of a node based on the `type` property in the YAML frontmatter of the corresponding document.
 
 For example the following `backlinking.md` note:
@@ -46,6 +48,7 @@ type: feature
 ```
 
 And the following `settings.json`:
+
 ```json
 "foam.graph.style": {
     "node": {
@@ -57,6 +60,3 @@ And the following `settings.json`:
 Will result in the following graph:
 
 ![Style node by type](../assets/images/style-node-by-type.png)
-
-
-

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,27 +2,31 @@
 
 ## 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
 
 ## Specification
 
 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)
@@ -67,7 +71,6 @@ After changing the setting in your workspace, you can run the [[workspace-janito
 
 See [[link-reference-definition-improvements]] for further discussion on current problems and potential solutions.
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [workspace-janitor]: workspace-janitor.md "Janitor"
 [todo]: ../dev/todo.md "Todo"

docs/features/note-templates.md

@@ -1,27 +1,187 @@
 # Note Templates
 
-Foam supports note templates.
+Foam supports note templates. Templates are a way to customize the starting content for your notes (instead of always starting from an empty note).
 
-Note templates live in `.foam/templates`. Run the `Foam: Create New Template` command from the command palette or create a regular `.md` file there to add a template.
+Note templates are files located in the special `.foam/templates` directory.
+
+## Quickstart
+
+Create a template:
+
+* Run the `Foam: Create New Template` command from the command palette
+* OR manually create a regular `.md` file in the `.foam/templates` directory
 
 ![Create new template GIF](../assets/images/create-new-template.gif)
 
 _Theme: Ayu Light_
 
-To create a note from a template, execute the `Foam: Create New Note From Template` command and follow the instructions. Don't worry if you've not created a template yet! You'll be prompted to create a new template if none exist.
+To create a note from a template:
+
+* Run the `Foam: Create New Note From Template` command and follow the instructions. Don't worry if you've not created a template yet! You'll be prompted to create a new template if none exist.
+* OR run the `Foam: Create New Note` command, which uses the special default template (`.foam/templates/new-note.md`, if it exists)
 
 ![Create new note from template GIF](../assets/images/create-new-note-from-template.gif)
 
 _Theme: Ayu Light_
 
-### Variables
+## 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

@@ -3,15 +3,22 @@
 Foam supports tags.
 
 ## Creating a tag
+
 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.
 In the future it will be possible to explore tags via the graph as well.
 
+## Styling tags
+Inline tags can be styled using custom CSS with the selector `.foam-tag`.
+
 ## An alternative to tags
 
 Given the power of backlinks, some people prefer to use them also as tags.

docs/features/workspace-janitor.md

@@ -5,10 +5,12 @@ To store your personal knowledge graph in markdown files instead of a database,
 **Foam Janitor** (inspired by Andy Matuschak's [note-link-janitor](https://github.com/andymatuschak/note-link-janitor)) helps you migrate existing notes to Foam, and maintain your Foam's health over time.
 
 Currently, Foam's Janitor helps you to:
+
 - Ensure your [[link-reference-definitions]] are up to date
 - Ensure every document has a well-formatted title (required for Markdown Links, Markdown Notes, and Foam Gatsby Template compatibility)
 
 In the future, Janitor can help you with
+
 - Updating [[materialized-backlinks]]
 - Lint, format and structure notes
 - Rename and move notes around while keeping their references up to date.

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

@@ -5,7 +5,7 @@ Uncategorised thoughts, to be added
 - Release notes
 - Markdown Preview
   - It's possible to customise the markdown preview styling. **Maybe make it use local foam workspace styles for live preview of the site??**
-    - See: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-preview-github-styles
+    - See: <https://marketplace.visualstudio.com/items?itemName=bierner.markdown-preview-github-styles>
 - Use VS Code [CodeTour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) for onboarding
 - Investigate other similar extensions:
   - [Unotes](https://marketplace.visualstudio.com/items?itemName=ryanmcalister.Unotes)
@@ -16,10 +16,10 @@ Uncategorised thoughts, to be added
   - Every Foam could have a different theme even in the editor, so you'll see it like they see it
     - UI and layout design of your workspace can become a thing
 - VS Code Notebooks API
-  - https://code.visualstudio.com/api/extension-guides/notebook
+  - <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...
@@ -32,5 +32,3 @@ Uncategorised thoughts, to be added
   - Maps have persistent topologies. As the graph grows, you should be able to visualise where an idea belongs. Maybe a literal map? And island? A DeckGL visualisation?
 
 Testing: This file is served from the /docs directory.
-
-

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]].
@@ -198,6 +200,30 @@ If that sounds like something you're interested in, I'd love to have you along o
   </tr>
   <tr>
     <td align="center"><a href="http://twitter.com/deegovee"><img src="https://avatars.githubusercontent.com/u/4730170?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Dheepak </b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dheepakg" title="Documentation">📖</a></td>
+    <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>
 </table>
 

docs/meeting-notes/foam-core-2020-07-11.md

@@ -13,6 +13,7 @@ Present: @jevakallio, @riccardoferretti
 
 - Land work to master
   - Create a foam-core package
+
   -
 
 ### Open questions

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
@@ -48,7 +48,6 @@ While Foam uses tools popular among computer programmers, Foam should be inclusi
 - **Foam is not just for programmers.** If you're a programmer, feel free to write scripts and extensions to support your own workflow, and publish them for others to use, but the out of the box Foam experience should not require you to know how to do so. You should, however, be curious and open to adopting new tools that are unfamiliar to you, and evaluate whether they could work for you.
 - **Foam is for everyone** As a foam user, you support everyone's quest for knowledge and self-improvement, not only your own, or folks' who look like you. All participants in Foam repositories, discussion forums, physical and virtual meeting spaces etc are expected to respect each other as described in our [[code-of-conduct]]. **Foam is not for toxic tech bros.**
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [recipes]: recipes/recipes.md "Recipes"
 [recommended-extensions]: recommended-extensions.md "Recommended Extensions"

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/templates-v2.md

@@ -42,6 +42,7 @@ The current capabilities of templates is limited in some important ways. This do
 Creating of new notes in Foam is too cumbersome and slow. Despite their power, Foam templates can currently only be used in very limited scenarios.
 
 This proposal aims to address these issues by streamlining note creation and by allowing templates to be used everywhere.
+
 ## Limitations of current templating
 
 ### Too much friction to create a new note
@@ -162,14 +163,16 @@ This would open use the template found at `.foam/templates/new-note.md` to creat
 #### Case 1: `.foam/templates/new-note.md` doesn't exist
 
 If `.foam/templates/new-note.md` doesn't exist, it behaves the same as `Markdown Notes: New Note`:
-  * it would ask for a title and create the note in the current directory. It would open a note with the note containing the title.
+
+* it would ask for a title and create the note in the current directory. It would open a note with the note containing the title.
 
 **Note:** this would use an implicit default template, making use of the `${title}` variable.
 
 #### Case 2: `.foam/templates/new-note.md` exists
 
 If `.foam/templates/new-note.md` exists:
-  * it asks for the note title and creates the note in the current directory
+
+* it asks for the note title and creates the note in the current directory
 
 **Progress:** At this point, we have a faster way to create new notes from templates.
 

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,20 +2,22 @@
 
 ## 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
 
 When you're ready to publish, run a local build.
+
 ```bash
 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.)
 
@@ -26,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-azure-devops-wiki.md

@@ -11,14 +11,15 @@ The following recipe is written with the assumption that you already have an [Az
 1. Generate a Foam workspace using the [foam-template project](https://github.com/foambubble/foam-template).
 2. Change the remote to a git repository in Azure DevOps (Repos -> Import a Repository -> Add Clone URL with Authentication), or copy all the files into a new Azure DevOps git repository.
 3. Define which document will be the wiki home page. To do that, create a file called `.order` in the Foam workspace root folder, with first line being the document filename without `.md` extension. For a project created from the Foam template, the file would look like this:
+
 ```
 readme
 ```
+
 4. Push the repository to remote in Azure DevOps.
 
 ## Publish repository to a wiki
 
-
 1. Navigate to your Azure DevOps project in a web browser.
 2. Choose **Overview** > **Wiki**. If you don't have wikis for your project, choose **Publish code as a wiki** on welcome page.
 3. Choose repository with your Foam workspace, branch (usually `master` or `main`), folder (for workspace created from foam-template it is `/`), and wiki name, and press **Publish**.
@@ -40,6 +41,7 @@ While you are pushing changes to GitHub, you won't see the wiki updated if you d
  3. You can then add the remote for your second remote repository, in this case, Azure. e.g `git remote add azure https://<YOUR_ID>@dev.azure.com/<YOUR_ID>/foam-notes/_git/foam-notes`. You can get it from: Repos->Files->Clone and copy the URL.
  4. Now, you need to set up your origin remote to push to both of these. So run: `git config -e` and edit it.
  5. Add the `remote origin` section to the bottom of the file with the URLs from each remote repository you'd like to push to. You'll see something like that:
+
  ```bash
  [core]
   ...
@@ -58,6 +60,7 @@ While you are pushing changes to GitHub, you won't see the wiki updated if you d
   url = git@github.com:username/repo.git
   url = https://<YOUR_ID>@dev.azure.com/<YOUR_ID>/foam-notes/_git/foam-notes
  ```
+
  6. You can then push to both repositories by: `git push origin master` or a single one using: `git push github master` or `git push azure master`
 
 For more information, read the [Azure DevOps documentation](https://docs.microsoft.com/en-us/azure/devops/project/wiki/publish-repo-to-wiki).

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

@@ -1,44 +1,49 @@
-# 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
 
 If you want to test your published foam, follow the instructions:
-- https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll
-- https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll
+
+- <https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll>
+- <https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll>
 
 Assuming you have installed ruby/jekyll and the rest:
+
 - `touch Gemfile`
   - open the file and paste the following:
+
 ```
 source 'https://rubygems.org'
 
 gem "github-pages", "VERSION"
 ```
-replacing `VERSION` with the latest from https://rubygems.org/gems/github-pages (e.g. `gem "github-pages", "209"`)
+
+replacing `VERSION` with the latest from <https://rubygems.org/gems/github-pages> (e.g. `gem "github-pages", "209"`)
+
 - `bundle`
 - `bundle exec jekyll 3.9.0 new .`
 - edit the `Gemfile` according to the instructions at [Creating Your Site](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll#creating-your-site) Point n.8
 - `bundle exec jekyll serve`
 
-
 ## Other templates
+
 There are many other templates which also support publish your foam workspace to github pages
 
 * gatsby-digital-garden
-    * [repo](https://github.com/mathieudutour/gatsby-digital-garden)
-    * [demo-website](https://mathieudutour.github.io/gatsby-digital-garden/)
+  * [repo](https://github.com/mathieudutour/gatsby-digital-garden)
+  * [demo-website](https://mathieudutour.github.io/gatsby-digital-garden/)
 * foam-mkdocs-template
-    * [repo](https://github.com/Jackiexiao/foam-mkdocs-template)
-    * [demo-website](https://jackiexiao.github.io/foam/)
+  * [repo](https://github.com/Jackiexiao/foam-mkdocs-template)
+  * [demo-website](https://jackiexiao.github.io/foam/)
 * foam-jekyll-template
-    * [repo](https://github.com/hikerpig/foam-jekyll-template)
-    * [demo-website](https://hikerpig.github.io/foam-jekyll-template/)
+  * [repo](https://github.com/hikerpig/foam-jekyll-template)
+  * [demo-website](https://hikerpig.github.io/foam-jekyll-template/)
 
 [[todo]] [[good-first-task]] Improve this documentation
 

docs/publishing/publish-to-github.md

@@ -5,11 +5,13 @@ The standard [foam-template](https://github.com/foambubble/foam-template) is rea
 ## Enable navigation in GitHub
 
 To allow navigation from within the GitHub repo, make sure to generate the link references, by setting
+
 - `Foam › Edit: Link Reference Definitions` -> `withExtensions`
 
 See [[link-reference-definitions]] for more information.
 
 ## Customising the style
+
 You can edit `assets/css/style.scss` to change how published pages look.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"

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

@@ -2,15 +2,178 @@
 
 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
+
 Add another file to the root directory (the one with `readme.md` in it) called `_config.yaml` (no extension)
 
 ```yaml
@@ -46,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-netlify-with-eleventy.md

@@ -3,6 +3,7 @@
 You can use [foam-eleventy-template](https://github.com/juanfrank77/foam-eleventy-template) to generate a static site with [Eleventy](https://www.11ty.dev/), and host it online on [Netlify](https://www.netlify.com/).
 
 With this template you can
+
 - Have control over what to publish and what to keep private
 - Customize the styling of the site to your own liking
 
@@ -12,8 +13,6 @@ When you're ready to publish, import the GitHub repository you created with **fo
 
 Once that's done, all you have to do is make changes to your workspace in VS Code and push them to the main branch on GitHub. Netlify will recognize the changes, deploy them automatically and give you a link where your Foam is published.
 
-
 That's it!
 
 You can now see it online and use that link to share it with your friends, so that they can see it too.
-

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/reading-list.md

@@ -5,8 +5,6 @@
 - [VSCode Extensions Packs](https://code.visualstudio.com/blogs/2017/03/07/extension-pack-roundup) [[todo]] Evaluate for deployment
 - [Dark mode](https://css-tricks.com/dark-modes-with-css/)
 
-
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: dev/todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/recipes/automatic-git-syncing.md

@@ -5,7 +5,7 @@ You can also easily manipulate the git history to reduce clutter.
 
 ## Required Extensions
 
- - [GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc)
+- [GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc)
 
 ## Instructions
 
@@ -18,9 +18,6 @@ __For Foam specific needs, you can add a comment here by following the [[contrib
 - Feedback and issues with the extension should be reported to the authors themselves
 - Feedback and issues with the integration of the extension in Foam can be reported in our [issue tracker](https://github.com/foambubble/foam/issues)
 
-
-
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [contribution-guide]: ../contribution-guide.md "Contribution Guide"
 [//end]: # "Autogenerated link references"

docs/recipes/automatically-expand-urls-to-well-titled-links.md

@@ -4,7 +4,7 @@ With this #recipe you can convert a link to a fully-formed Markdown link, using
 
 ## Required Extensions
 
- - [Markdown Link Expander](https://marketplace.visualstudio.com/items?itemName=skn0tt.markdown-link-expander) (not included in template)
+- [Markdown Link Expander](https://marketplace.visualstudio.com/items?itemName=skn0tt.markdown-link-expander) (not included in template)
 
 Markdown Link Expander will scrape your URL's `<title>` tag to create a nice Markdown-style link.
 
@@ -22,4 +22,3 @@ Tip: If you paste a lot of links, give the action a custom [key binding](https:/
 ## Feedback and issues
 
 Have an idea for the extension? [Feel free to share! 🎉](https://github.com/Skn0tt/markdown-link-expander/issues)
-

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/capture-notes-with-shortcuts-and-github-actions.md

@@ -15,8 +15,7 @@ With this #recipe you can create notes on your iOS device, which will automatica
 
 ## Instructions
 
-
-1. Setup the [`foam-capture-action`]() in your GitHub Repository, to be triggered by "Workflow dispatch" events. 
+1. Setup the [`foam-capture-action`]() in your GitHub Repository, to be triggered by "Workflow dispatch" events.
 
 ```
 name: Manually triggered workflow
@@ -26,15 +25,17 @@ on:
       data:
         description: 'What information to put in the knowledge base.'
         required: true
-        
+
 jobs:
   store_data:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
     - uses: anglinb/foam-capture-action@main
-      with: 
+      with:
+        {% raw %}
         capture: ${{ github.event.inputs.data }}
+        {% endraw %}
     - run: |
         git config --local user.email "example@gmail.com"
         git config --local user.name "Your name"
@@ -44,14 +45,16 @@ jobs:
 
 2. In GitHub [create a Personal Access Token](https://github.com/settings/tokens) and give it `repo` scope - make a note of the token
 3. Run this command to find your `workflow-id` to be used in the Shortcut.
+
 ```bash
 curl \
   -H "Accept: application/vnd.github.v3+json" \
   -H "Authorization: Bearer <GITHUB_TOKEN>" \
     https://api.github.com/repos/<owner>/<repository>/actions/workflows
 ```
+
 4. Copy this [Shortcut](https://www.icloud.com/shortcuts/57d2ed90c40e43a5badcc174ebfaaf1d) to your iOS devices and edit the contents of the last step, `GetContentsOfURL`
    - Make sure you update the URL of the shortcut step with the `owner`, `repository`, `workflow-id` (from the previous step)
-   - Make sure you update the headers of the shortcut step, replaceing `[GITHUB_TOKEN]` with your Personal Access Token (from step 2) 
+   - Make sure you update the headers of the shortcut step, replaceing `[GITHUB_TOKEN]` with your Personal Access Token (from step 2)
 
 5. Run the shortcut & celebrate! ✨ (You should see a GitHub Action run start and the text you entered show up in `inbox.md` in your repository.)

docs/recipes/diagrams-in-markdown.md

@@ -7,13 +7,10 @@ We have two alternative #recipe for displaying diagrams in markdown:
   - [Draw.io](#drawio)
     - [Using Draw.io](#using-drawio)
 
-
 ## Mermaid
 
 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,7 +24,6 @@ You can use [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierne
 3. Start drawing your diagram. Once you done, save it.
 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/how-to-write-recipes.md

@@ -3,6 +3,7 @@
 This is an example of how to structure a Recipe. The first paragraph or two should explain the purpose of the recipe succinctly, including why it's useful, if that's not obvious.
 
 Recipes are intended to document:
+
 - How to use Foam's basic features
 - Power user pro-tips
 - Useful customisations of the default Foam environment
@@ -10,8 +11,8 @@ Recipes are intended to document:
 
 ## Required Extensions
 
- - **[Hacker Typer](https://marketplace.visualstudio.com/items?itemName=jevakallio.vscode-hacker-typer)** (not really required for this recipe, just an example)
- - [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) (installed by default)
+- **[Hacker Typer](https://marketplace.visualstudio.com/items?itemName=jevakallio.vscode-hacker-typer)** (not really required for this recipe, just an example)
+- [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) (installed by default)
 
 The first section should be a bulleted list of extensions required to use this recipe. At a minimum, this section should list all additional, non-standard extensions.
 

docs/recipes/make-backlinks-more-prominent.md

@@ -16,11 +16,6 @@ In the future we'll want to improve this feature by
 - Make back links editable using [VS Code Search Editors](https://code.visualstudio.com/updates/v1_43#_search-editors)
   - [Suggested by @Jash on Discord](https://discordapp.com/channels/729975036148056075/729978910363746315/730999992419876956)
 
-
-
-
-
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [materialized-backlinks]: ../dev/materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

docs/recipes/migrating-from-obsidian.md

@@ -4,7 +4,6 @@
 
 If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [todo]: ../dev/todo.md "Todo"
 [roadmap]: ../dev/roadmap.md "Roadmap"

docs/recipes/note-macros.md

@@ -56,6 +56,3 @@ in `keybindings.json` (Code|File > Preferences > Keyboard Shortcuts) add binding
 If you have any issues or questions please look at the [README.md](https://github.com/kneely/note-macros#note-macros) on the [note-macros](https://github.com/kneely/note-macros) GitHub.
 
 If you run into any issues that are not fixed by referring to the README or feature requests please open an [issue](https://github.com/kneely/note-macros/issues).
-
-
-

docs/recipes/real-time-collaboration.md

@@ -1,4 +1,3 @@
 # Real-time Collaboration
 
 This #recipe is here to just tell you that VS Code Live Share will allow you to collaborate live on your notes.
-

docs/recipes/recipes.md

@@ -26,15 +26,18 @@ A #recipe is a guide, tip or strategy for getting the most out of your Foam work
 - Clip webpages with [[web-clipper]]
 
 ## Discover
+
 - Explore your notes using [[graph-visualisation]]
 - Discover relationships with [[backlinking]]
 - Simulating [[unlinked-references]]
 
 ## Organise
+
 - Using [[backlinking]] for reference lists.
 
 ## 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]]
@@ -53,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
 
@@ -109,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"
@@ -122,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

@@ -9,16 +9,18 @@ The most promising options are:
 ### [GitJournal](https://gitjournal.io/)
 
 Pros
+
 - Open source
 - Already a usable solution.
 - 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
 
 Cons
+
 - Doesn't generate link reference lists (but this is ok, since [[workspace-janitor]] as a GitHub action can solve this)
 - Not as sleek as Apple/Google notes, some keyboard state glitching on Android, etc.
 - Lack of control over roadmap. Established product with a paid plan, so may not be open to Foam-supportive changes and additions that don't benefit most users.
@@ -28,13 +30,15 @@ Verdict: Good. By far best effort/outcome ratio would be to help improve GitJour
 ### GitHub Codespaces
 
 Pros
+
 - Works out of the box just like the desktop app
 
 Cons
+
 - not generally available quite yet
 - [Pricing](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/about-billing-for-codespaces)
 
-For a quick demo, see https://www.youtube.com/watch?v=KI5m4Uy8_4I.
+For a quick demo, see <https://www.youtube.com/watch?v=KI5m4Uy8_4I>.
 
 Verdict: Good. Pricing should be reasonable for taking notes on the fly. Harder to assess for people who would constantly use Foam from mobile phone.
 
@@ -54,7 +58,6 @@ If such an app was worth building, it would have to have the following features:
 
 Given the effort vs reward ratio, it's a low priority for core team, but if someone wants to work on this, we can provide support! Talk to us on the #mobile-apps channel on [Foam Discord](https://foambubble.github.io/join-discord/w).
 
-
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [build-vs-assemble]: ../dev/build-vs-assemble.md "Build vs Assemble"
 [workspace-janitor]: ../features/workspace-janitor.md "Janitor"

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,10 +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
 
@@ -16,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/terminology.md

@@ -17,4 +17,3 @@ Also happens to sound quite a lot like Home. Funny, that.
 ## Bubble
 
 Individual Foam note, written in Markdown.
-

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.1"
+  "version": "0.17.5"
 }

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",
@@ -40,5 +36,6 @@
     "semi": true,
     "singleQuote": true,
     "trailingComma": "es5"
-  }
+  },
+  "dependencies": {}
 }

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.1",
-  "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,56 +0,0 @@
-import { createMarkdownParser } from './markdown-provider';
-import { FoamConfig, Foam, IDataStore } from './index';
-import { loadPlugins } from './plugins';
-import { isSome } from './utils';
-import { Logger } from './utils/log';
-import { URI } from './model/uri';
-import { FoamWorkspace } from './model/workspace';
-
-export const bootstrap = async (config: FoamConfig, dataStore: IDataStore) => {
-  const plugins = await loadPlugins(config);
-
-  const parserPlugins = plugins.map(p => p.parser).filter(isSome);
-  const parser = createMarkdownParser(parserPlugins);
-
-  const workspace = new FoamWorkspace();
-  const files = await dataStore.listFiles();
-  await Promise.all(
-    files.map(async uri => {
-      Logger.info('Found: ' + uri);
-      if (URI.isMarkdownFile(uri)) {
-        const content = await dataStore.read(uri);
-        if (isSome(content)) {
-          workspace.set(parser.parse(uri, content));
-        }
-      }
-    })
-  );
-  workspace.resolveLinks(true);
-
-  const listeners = [
-    dataStore.onDidChange(async uri => {
-      const content = await dataStore.read(uri);
-      isSome(content) && workspace.set(await parser.parse(uri, content));
-    }),
-    dataStore.onDidCreate(async uri => {
-      const content = await dataStore.read(uri);
-      isSome(content) && workspace.set(await parser.parse(uri, content));
-    }),
-    dataStore.onDidDelete(uri => {
-      workspace.delete(uri);
-    }),
-  ];
-
-  return {
-    workspace: workspace,
-    config: config,
-    services: {
-      dataStore,
-      parser,
-    },
-    dispose: () => {
-      listeners.forEach(l => l.dispose());
-      workspace.dispose();
-    },
-  } as 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,77 +0,0 @@
-import {
-  Resource,
-  Attachment,
-  Placeholder,
-  Note,
-  NoteLink,
-  isNote,
-  NoteLinkDefinition,
-  isPlaceholder,
-  isAttachment,
-  getTitle,
-  NoteParser,
-} from './model/note';
-import { FoamConfig } from './config';
-import { IDataStore, FileDataStore } from './services/datastore';
-import { ILogger } from './utils/log';
-import { IDisposable, isDisposable } from './common/lifecycle';
-import { FoamWorkspace } from './model/workspace';
-import { URI } from './model/uri';
-
-export { Position } from './model/position';
-export { Range } from './model/range';
-export { IDataStore, FileDataStore };
-export { ILogger };
-export { LogLevel, LogLevelThreshold, Logger, BaseLogger } from './utils/log';
-export { Event, Emitter } from './common/event';
-export { FoamConfig };
-
-export { IDisposable, isDisposable };
-
-export {
-  createMarkdownReferences,
-  stringifyMarkdownLinkReferenceDefinition,
-  createMarkdownParser,
-} 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,
-  Attachment,
-  Placeholder,
-  Note,
-  NoteLink,
-  URI,
-  FoamWorkspace,
-  NoteLinkDefinition,
-  NoteParser,
-  isNote,
-  isPlaceholder,
-  isAttachment,
-  getTitle,
-};
-
-export interface Services {
-  dataStore: IDataStore;
-  parser: NoteParser;
-}
-
-export interface Foam extends IDisposable {
-  services: Services;
-  workspace: FoamWorkspace;
-  config: FoamConfig;
-}

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

@@ -1,340 +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,
-  Note,
-  NoteParser,
-  isWikilink,
-  getTitle,
-} 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';
-
-/**
- * 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 == null && 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 == null) {
-      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[]): NoteParser {
-  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: NoteParser = {
-    parse: (uri: URI, markdown: string): Note => {
-      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: Note = {
-        uri: uri,
-        type: 'note',
-        properties: {},
-        title: null,
-        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: getTitle(target) };
-    })
-    .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
-  );

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

@@ -1,84 +0,0 @@
-import { URI } from './uri';
-import { Position } from './position';
-import { Range } from './range';
-
-export interface NoteSource {
-  text: string;
-  contentStart: Position;
-  end: Position;
-  eol: string;
-}
-
-export interface WikiLink {
-  type: 'wikilink';
-  slug: string;
-  target: string;
-  range: Range;
-}
-
-export interface DirectLink {
-  type: 'link';
-  label: string;
-  target: string;
-  range: Range;
-}
-
-export type NoteLink = WikiLink | DirectLink;
-
-export interface NoteLinkDefinition {
-  label: string;
-  url: string;
-  title?: string;
-  range?: Range;
-}
-
-export interface BaseResource {
-  uri: URI;
-}
-
-export interface Attachment extends BaseResource {
-  type: 'attachment';
-}
-
-export interface Placeholder extends BaseResource {
-  type: 'placeholder';
-}
-
-export interface Note extends BaseResource {
-  type: 'note';
-  title: string | null;
-  properties: any;
-  // sections: NoteSection[]
-  tags: Set<string>;
-  links: NoteLink[];
-  definitions: NoteLinkDefinition[];
-  source: NoteSource;
-}
-
-export type Resource = Note | Attachment | Placeholder;
-
-export interface NoteParser {
-  parse: (uri: URI, text: string) => Note;
-}
-
-export const isWikilink = (link: NoteLink): link is WikiLink => {
-  return link.type === 'wikilink';
-};
-
-export const getTitle = (resource: Resource): string => {
-  return resource.type === 'note'
-    ? resource.title ?? URI.getBasename(resource.uri)
-    : URI.getBasename(resource.uri);
-};
-
-export const isNote = (resource: Resource): resource is Note => {
-  return resource.type === 'note';
-};
-
-export const isPlaceholder = (resource: Resource): resource is Placeholder => {
-  return resource.type === 'placeholder';
-};
-
-export const isAttachment = (resource: Resource): resource is Attachment => {
-  return resource.type === 'attachment';
-};

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

@@ -1,485 +0,0 @@
-import { diff } from 'fast-array-diff';
-import { isEqual } from 'lodash';
-import * as path from 'path';
-import { Resource, NoteLink, Note } from './note';
-import { Range } from './range';
-import { URI } from './uri';
-import { isSome, isNone } from '../utils';
-import { Emitter } from '../common/event';
-import { IDisposable } from '../index';
-
-export type Connection = {
-  source: URI;
-  target: URI;
-  link: NoteLink;
-};
-
-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;
-const uriToResourceName = (uri: URI) => pathToResourceName(uri.path);
-
-const pathToPlaceholderId = (value: string) => value;
-const uriToPlaceholderId = (uri: URI) => pathToPlaceholderId(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;
-
-  /**
-   * Resources by key / slug
-   */
-  private resourcesByName: { [key: string]: string[] } = {};
-  /**
-   * Resources by URI
-   */
-  private resources: { [key: string]: Resource } = {};
-  /**
-   * Placehoders by key / slug / value
-   */
-  private placeholders: { [key: string]: Resource } = {};
-
-  /**
-   * Maps the connections starting from a URI
-   */
-  private links: { [key: string]: Connection[] } = {};
-  /**
-   * Maps the connections arriving to a URI
-   */
-  private backlinks: { [key: string]: Connection[] } = {};
-  /**
-   * List of disposables to destroy with the workspace
-   */
-  disposables: IDisposable[] = [];
-
-  exists(uri: URI) {
-    return FoamWorkspace.exists(this, uri);
-  }
-  list() {
-    return FoamWorkspace.list(this);
-  }
-  get(uri: URI) {
-    return FoamWorkspace.get(this, uri);
-  }
-  find(uri: URI | string) {
-    return FoamWorkspace.find(this, uri);
-  }
-  set(resource: Resource) {
-    return FoamWorkspace.set(this, resource);
-  }
-  delete(uri: URI) {
-    return FoamWorkspace.delete(this, uri);
-  }
-
-  resolveLink(note: Note, link: NoteLink) {
-    return FoamWorkspace.resolveLink(this, note, link);
-  }
-  resolveLinks(keepMonitoring: boolean = false) {
-    return FoamWorkspace.resolveLinks(this, keepMonitoring);
-  }
-  getAllConnections() {
-    return FoamWorkspace.getAllConnections(this);
-  }
-  getConnections(uri: URI) {
-    return FoamWorkspace.getConnections(this, uri);
-  }
-  getLinks(uri: URI) {
-    return FoamWorkspace.getLinks(this, uri);
-  }
-  getBacklinks(uri: URI) {
-    return FoamWorkspace.getBacklinks(this, uri);
-  }
-
-  dispose(): void {
-    this.onDidAddEmitter.dispose();
-    this.onDidDeleteEmitter.dispose();
-    this.onDidUpdateEmitter.dispose();
-    this.disposables.forEach(d => d.dispose());
-  }
-
-  public static resolveLink(
-    workspace: FoamWorkspace,
-    note: Note,
-    link: NoteLink
-  ): URI {
-    let targetUri: URI | undefined;
-    switch (link.type) {
-      case 'wikilink':
-        const definitionUri = note.definitions.find(
-          def => def.label === link.slug
-        )?.url;
-        if (isSome(definitionUri)) {
-          const definedUri = URI.resolve(definitionUri, note.uri);
-          targetUri =
-            FoamWorkspace.find(workspace, definedUri, note.uri)?.uri ??
-            URI.placeholder(definedUri.path);
-        } else {
-          targetUri =
-            FoamWorkspace.find(workspace, link.slug, note.uri)?.uri ??
-            URI.placeholder(link.slug);
-        }
-        break;
-
-      case 'link':
-        targetUri =
-          FoamWorkspace.find(workspace, link.target, note.uri)?.uri ??
-          URI.placeholder(URI.resolve(link.target, note.uri).path);
-        break;
-    }
-    return targetUri;
-  }
-
-  /**
-   * 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 resolved workspace
-   */
-  public static resolveLinks(
-    workspace: FoamWorkspace,
-    keepMonitoring: boolean = false
-  ): FoamWorkspace {
-    workspace.links = {};
-    workspace.backlinks = {};
-    workspace.placeholders = {};
-
-    workspace = Object.values(workspace.list()).reduce(
-      (w, resource) => FoamWorkspace.resolveResource(w, resource),
-      workspace
-    );
-    if (keepMonitoring) {
-      workspace.disposables.push(
-        workspace.onDidAdd(resource => {
-          FoamWorkspace.updateLinksRelatedToAddedResource(workspace, resource);
-        }),
-        workspace.onDidUpdate(change => {
-          FoamWorkspace.updateLinksForResource(
-            workspace,
-            change.old,
-            change.new
-          );
-        }),
-        workspace.onDidDelete(resource => {
-          FoamWorkspace.updateLinksRelatedToDeletedResource(
-            workspace,
-            resource
-          );
-        })
-      );
-    }
-    return workspace;
-  }
-
-  public static getAllConnections(workspace: FoamWorkspace): Connection[] {
-    return Object.values(workspace.links).flat();
-  }
-
-  public static getConnections(
-    workspace: FoamWorkspace,
-    uri: URI
-  ): Connection[] {
-    return [
-      ...(workspace.links[uri.path] || []),
-      ...(workspace.backlinks[uri.path] || []),
-    ];
-  }
-
-  public static getLinks(workspace: FoamWorkspace, uri: URI): Connection[] {
-    return workspace.links[uri.path] ?? [];
-  }
-
-  public static getBacklinks(workspace: FoamWorkspace, uri: URI): Connection[] {
-    return workspace.backlinks[uri.path] ?? [];
-  }
-
-  public static set(
-    workspace: FoamWorkspace,
-    resource: Resource
-  ): FoamWorkspace {
-    if (resource.type === 'placeholder') {
-      workspace.placeholders[uriToPlaceholderId(resource.uri)] = resource;
-      return workspace;
-    }
-    const id = uriToResourceId(resource.uri);
-    const old = FoamWorkspace.find(workspace, resource.uri);
-    const name = uriToResourceName(resource.uri);
-    workspace.resources[id] = resource;
-    workspace.resourcesByName[name] = workspace.resourcesByName[name] ?? [];
-    workspace.resourcesByName[name].push(id);
-    isSome(old)
-      ? workspace.onDidUpdateEmitter.fire({ old: old, new: resource })
-      : workspace.onDidAddEmitter.fire(resource);
-    return workspace;
-  }
-
-  public static exists(workspace: FoamWorkspace, uri: URI): boolean {
-    return isSome(workspace.resources[uriToResourceId(uri)]);
-  }
-
-  public static list(workspace: FoamWorkspace): Resource[] {
-    return [
-      ...Object.values(workspace.resources),
-      ...Object.values(workspace.placeholders),
-    ];
-  }
-
-  public static get(workspace: FoamWorkspace, uri: URI): Resource {
-    const note = FoamWorkspace.find(workspace, uri);
-    if (isSome(note)) {
-      return note;
-    } else {
-      throw new Error('Resource not found: ' + uri.path);
-    }
-  }
-
-  public static find(
-    workspace: FoamWorkspace,
-    resourceId: URI | string,
-    reference?: URI
-  ): Resource | null {
-    const refType = getReferenceType(resourceId);
-    switch (refType) {
-      case 'uri':
-        const uri = resourceId as URI;
-        if (uri.scheme === 'placeholder') {
-          return uri.path in workspace.placeholders
-            ? { type: 'placeholder', uri: uri }
-            : null;
-        } else {
-          return FoamWorkspace.exists(workspace, uri)
-            ? workspace.resources[uriToResourceId(uri)]
-            : null;
-        }
-
-      case 'key':
-        const name = pathToResourceName(resourceId as string);
-        const paths = workspace.resourcesByName[name];
-        if (isNone(paths) || paths.length === 0) {
-          const placeholderId = pathToPlaceholderId(resourceId as string);
-          return workspace.placeholders[placeholderId] ?? null;
-        }
-        // prettier-ignore
-        const sortedPaths = paths.length === 1
-          ? paths
-          : paths.sort((a, b) => a.localeCompare(b));
-        return workspace.resources[sortedPaths[0]];
-
-      case 'absolute-path':
-        const resourceUri = URI.file(resourceId as string);
-        return (
-          workspace.resources[uriToResourceId(resourceUri)] ??
-          workspace.placeholders[uriToPlaceholderId(resourceUri)]
-        );
-
-      case 'relative-path':
-        if (isNone(reference)) {
-          return null;
-        }
-        const relativePath = resourceId as string;
-        const targetUri = URI.computeRelativeURI(reference, relativePath);
-        return (
-          workspace.resources[uriToResourceId(targetUri)] ??
-          workspace.placeholders[pathToPlaceholderId(resourceId as string)]
-        );
-
-      default:
-        throw new Error('Unexpected reference type: ' + refType);
-    }
-  }
-
-  public static delete(workspace: FoamWorkspace, uri: URI): Resource | null {
-    const id = uriToResourceId(uri);
-    const deleted = workspace.resources[id];
-    delete workspace.resources[id];
-
-    const name = uriToResourceName(uri);
-    workspace.resourcesByName[name] =
-      workspace.resourcesByName[name]?.filter(resId => resId !== id) ?? [];
-    if (workspace.resourcesByName[name].length === 0) {
-      delete workspace.resourcesByName[name];
-    }
-
-    isSome(deleted) && workspace.onDidDeleteEmitter.fire(deleted);
-    return deleted ?? null;
-  }
-
-  public static resolveResource(workspace: FoamWorkspace, resource: Resource) {
-    if (resource.type === 'note') {
-      delete workspace.links[resource.uri.path];
-      // prettier-ignore
-      resource.links.forEach(link => {
-        const targetUri = FoamWorkspace.resolveLink(workspace, resource, link);
-        workspace = FoamWorkspace.connect(workspace, resource.uri, targetUri, link);
-      });
-    }
-    return workspace;
-  }
-
-  private static updateLinksForResource(
-    workspace: FoamWorkspace,
-    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);
-      workspace = patch.removed.reduce((ws, link) => {
-        const target = ws.resolveLink(oldResource, link);
-        return FoamWorkspace.disconnect(ws, oldResource.uri, target, link);
-      }, workspace);
-      workspace = patch.added.reduce((ws, link) => {
-        const target = ws.resolveLink(newResource, link);
-        return FoamWorkspace.connect(ws, newResource.uri, target, link);
-      }, workspace);
-    }
-    return workspace;
-  }
-
-  private static updateLinksRelatedToAddedResource(
-    workspace: FoamWorkspace,
-    resource: Resource
-  ) {
-    // check if any existing connection can be filled by new resource
-    const name = uriToResourceName(resource.uri);
-    if (name in workspace.placeholders) {
-      const placeholder = workspace.placeholders[name];
-      delete workspace.placeholders[name];
-      const resourcesToUpdate = workspace.backlinks[placeholder.uri.path] ?? [];
-      workspace = resourcesToUpdate.reduce(
-        (ws, res) => FoamWorkspace.resolveResource(ws, ws.get(res.source)),
-        workspace
-      );
-    }
-
-    // resolve the resource
-    workspace = FoamWorkspace.resolveResource(workspace, resource);
-  }
-
-  private static updateLinksRelatedToDeletedResource(
-    workspace: FoamWorkspace,
-    resource: Resource
-  ) {
-    const uri = resource.uri;
-
-    // remove forward links from old resource
-    const resourcesPointedByDeletedNote = workspace.links[uri.path] ?? [];
-    delete workspace.links[uri.path];
-    workspace = resourcesPointedByDeletedNote.reduce(
-      (ws, connection) =>
-        FoamWorkspace.disconnect(ws, uri, connection.target, connection.link),
-      workspace
-    );
-
-    // recompute previous links to old resource
-    const notesPointingToDeletedResource = workspace.backlinks[uri.path] ?? [];
-    delete workspace.backlinks[uri.path];
-    workspace = notesPointingToDeletedResource.reduce(
-      (ws, link) => FoamWorkspace.resolveResource(ws, ws.get(link.source)),
-      workspace
-    );
-    return workspace;
-  }
-
-  private static connect(
-    workspace: FoamWorkspace,
-    source: URI,
-    target: URI,
-    link: NoteLink
-  ) {
-    if (URI.isPlaceholder(target)) {
-      // we can only add placeholders when links are being resolved
-      workspace = FoamWorkspace.set(workspace, {
-        type: 'placeholder',
-        uri: target,
-      });
-    }
-    const connection = { source, target, link };
-
-    workspace.links[source.path] = workspace.links[source.path] ?? [];
-    workspace.links[source.path].push(connection);
-    workspace.backlinks[target.path] = workspace.backlinks[target.path] ?? [];
-    workspace.backlinks[target.path].push(connection);
-
-    return workspace;
-  }
-
-  /**
-   * 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 static disconnect(
-    workspace: FoamWorkspace,
-    source: URI,
-    target: URI,
-    link: NoteLink | true
-  ) {
-    const connectionsToKeep =
-      link === true
-        ? (c: Connection) =>
-            !URI.isEqual(source, c.source) || !URI.isEqual(target, c.target)
-        : (c: Connection) => !isSameConnection({ source, target, link }, c);
-
-    workspace.links[source.path] =
-      workspace.links[source.path]?.filter(connectionsToKeep) ?? [];
-    if (workspace.links[source.path].length === 0) {
-      delete workspace.links[source.path];
-    }
-    workspace.backlinks[target.path] =
-      workspace.backlinks[target.path]?.filter(connectionsToKeep) ?? [];
-    if (workspace.backlinks[target.path].length === 0) {
-      delete workspace.backlinks[target.path];
-      if (URI.isPlaceholder(target)) {
-        delete workspace.placeholders[uriToPlaceholderId(target)];
-      }
-    }
-    return workspace;
-  }
-}
-
-// 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: NoteLink, b: NoteLink) =>
-  a.type === b.type && Range.isEqual(a.range, b.range);

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 { Note } 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: Note) => void;
-  onDidInitializeParser?: (parser: unified.Processor) => void;
-  onWillParseMarkdown?: (markdown: string) => string;
-  onWillVisitTree?: (tree: Node, note: Note) => void;
-  onDidVisitTree?: (tree: Node, note: Note) => void;
-  onDidFindProperties?: (properties: any, note: Note) => 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/services/datastore.ts

@@ -1,184 +0,0 @@
-import glob from 'glob';
-import { promisify } from 'util';
-import micromatch from 'micromatch';
-import fs from 'fs';
-import { Event, Emitter } from '../common/event';
-import { URI } from '../model/uri';
-import { FoamConfig } from '../config';
-import { Logger } from '../utils/log';
-import { isSome } from '../utils';
-import { IDisposable } from '../common/lifecycle';
-
-const findAllFiles = promisify(glob);
-
-export interface IWatcher {
-  /**
-   * An event which fires on file creation.
-   */
-  onDidCreate: Event<URI>;
-
-  /**
-   * An event which fires on file change.
-   */
-  onDidChange: Event<URI>;
-
-  /**
-   * An event which fires on file deletion.
-   */
-  onDidDelete: Event<URI>;
-}
-
-/**
- * Represents a source of files and content
- */
-export interface IDataStore {
-  /**
-   * List the files available in the store
-   */
-  listFiles: () => Promise<URI[]>;
-
-  /**
-   * Read the content of the file from the store
-   *
-   * Returns `null` in case of errors while reading
-   */
-  read: (uri: URI) => Promise<string | null>;
-
-  /**
-   * Returns whether the given URI is a match in
-   * this data store
-   */
-  isMatch: (uri: URI) => boolean;
-
-  /**
-   * An event which fires on file creation.
-   */
-  onDidCreate: Event<URI>;
-
-  /**
-   * An event which fires on file change.
-   */
-  onDidChange: Event<URI>;
-
-  /**
-   * An event which fires on file deletion.
-   */
-  onDidDelete: Event<URI>;
-}
-
-/**
- * File system based data store
- */
-export class FileDataStore implements IDataStore, IDisposable {
-  readonly onDidChangeEmitter = new Emitter<URI>();
-  readonly onDidCreateEmitter = new Emitter<URI>();
-  readonly onDidDeleteEmitter = new Emitter<URI>();
-  readonly onDidCreate: Event<URI> = this.onDidCreateEmitter.event;
-  readonly onDidChange: Event<URI> = this.onDidChangeEmitter.event;
-  readonly onDidDelete: Event<URI> = this.onDidDeleteEmitter.event;
-
-  private _folders: readonly string[];
-  private _includeGlobs: string[] = [];
-  private _ignoreGlobs: string[] = [];
-  private _disposables: IDisposable[] = [];
-
-  constructor(config: FoamConfig, watcher?: IWatcher) {
-    this._folders = config.workspaceFolders.map(f =>
-      URI.toFsPath(f).replace(/\\/g, '/')
-    );
-    Logger.info('Workspace folders: ', this._folders);
-
-    this._folders.forEach(folder => {
-      const withFolder = folderPlusGlob(folder);
-      this._includeGlobs.push(
-        ...config.includeGlobs.map(glob => {
-          if (glob.endsWith('*')) {
-            glob = `${glob}\\.(md|mdx|markdown)`;
-          }
-          return withFolder(glob);
-        })
-      );
-      this._ignoreGlobs.push(...config.ignoreGlobs.map(withFolder));
-    });
-    Logger.info('Glob patterns', {
-      includeGlobs: this._includeGlobs,
-      ignoreGlobs: this._ignoreGlobs,
-    });
-
-    if (isSome(watcher)) {
-      this._disposables.push(
-        watcher.onDidCreate(uri => {
-          if (this.isMatch(uri)) {
-            Logger.info(`Created: ${uri.path}`);
-            this.onDidCreateEmitter.fire(uri);
-          }
-        }),
-        watcher.onDidChange(uri => {
-          if (this.isMatch(uri)) {
-            Logger.info(`Updated: ${uri.path}`);
-            this.onDidChangeEmitter.fire(uri);
-          }
-        }),
-        watcher.onDidDelete(uri => {
-          if (this.isMatch(uri)) {
-            Logger.info(`Deleted: ${uri.path}`);
-            this.onDidDeleteEmitter.fire(uri);
-          }
-        })
-      );
-    }
-  }
-
-  match(files: URI[]) {
-    const matches = micromatch(
-      files.map(f => URI.toFsPath(f)),
-      this._includeGlobs,
-      {
-        ignore: this._ignoreGlobs,
-        nocase: true,
-      }
-    );
-    return matches.map(URI.file);
-  }
-
-  isMatch(uri: URI) {
-    return this.match([uri]).length > 0;
-  }
-
-  async listFiles() {
-    const files = (
-      await Promise.all(
-        this._folders.map(async folder => {
-          const res = await findAllFiles(folderPlusGlob(folder)('**/*'));
-          return res.map(URI.file);
-        })
-      )
-    ).flat();
-    return this.match(files);
-  }
-
-  async read(uri: URI) {
-    try {
-      return (await fs.promises.readFile(URI.toFsPath(uri))).toString();
-    } catch (e) {
-      Logger.error(
-        `FileDataStore: error while reading uri: ${uri.path} - ${e}`
-      );
-      return null;
-    }
-  }
-
-  dispose() {
-    this._disposables.forEach(d => d.dispose());
-  }
-}
-
-const folderPlusGlob = (folder: string) => (glob: string): string => {
-  if (folder.substr(-1) === '/') {
-    folder = folder.slice(0, -1);
-  }
-  if (glob.startsWith('/')) {
-    glob = glob.slice(1);
-  }
-  return `${folder}/${glob}`;
-};

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();
-};