update yarn.lock file

* always convert vscode.Uri to foam.URI

* Improve handling on Windows paths in URI

- convert to upper case drive letter
- normalize use of Windows conversion in URI
- added more test cases

* Fixed tests

.all-contributorsrc

@@ -175,7 +175,8 @@
       "profile": "https://anku.netlify.com/",
       "contributions": [
         "doc",
-        "test"
+        "test",
+        "code"
       ]
     },
     {
@@ -186,7 +187,609 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "TaiChi-IO",
+      "name": "TaiChi-IO",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/65092992?v=4",
+      "profile": "https://github.com/TaiChi-IO",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "juanfrank77",
+      "name": "Juan F Gonzalez ",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/12146882?v=4",
+      "profile": "https://github.com/juanfrank77",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "SanketDG",
+      "name": "Sanket Dasgupta",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/8980971?v=4",
+      "profile": "https://sanketdg.github.io",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "nstafie",
+      "name": "Nicholas Stafie",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/10801854?v=4",
+      "profile": "https://github.com/nstafie",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "francishamel",
+      "name": "Francis Hamel",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/36383308?v=4",
+      "profile": "https://github.com/francishamel",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "digiguru",
+      "name": "digiguru",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/619436?v=4",
+      "profile": "http://digiguru.co.uk",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "chirag-singhal",
+      "name": "CHIRAG SINGHAL",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/42653703?v=4",
+      "profile": "https://github.com/chirag-singhal",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "lostintangent",
+      "name": "Jonathan Carter",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/116461?v=4",
+      "profile": "https://github.com/lostintangent",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "synesthesia",
+      "name": "Julian Elve",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/181399?v=4",
+      "profile": "https://www.synesthesia.co.uk",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "thomaskoppelaar",
+      "name": "Thomas Koppelaar",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/36331365?v=4",
+      "profile": "https://github.com/thomaskoppelaar",
+      "contributions": [
+        "question",
+        "code",
+        "userTesting"
+      ]
+    },
+    {
+      "login": "MehraAkshay",
+      "name": "Akshay",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/8671497?v=4",
+      "profile": "http://www.akshaymehra.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "johnlindquist",
+      "name": "John Lindquist",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/36073?v=4",
+      "profile": "http://johnlindquist.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "epicfaace",
+      "name": "Ashwin Ramaswami",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/1689183?v=4",
+      "profile": "https://ashwin.run/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Klaudioz",
+      "name": "Claudio Canales",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/632625?v=4",
+      "profile": "https://github.com/Klaudioz",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "vitaly-pevgonen",
+      "name": "vitaly-pevgonen",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/6272738?v=4",
+      "profile": "https://github.com/vitaly-pevgonen",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "dshemetov",
+      "name": "Dmitry Shemetov",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/1810426?v=4",
+      "profile": "https://dshemetov.github.io",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "hooncp",
+      "name": "hooncp",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/48883554?v=4",
+      "profile": "https://github.com/hooncp",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "martinlaws",
+      "name": "Martin Laws",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/13721239?v=4",
+      "profile": "http://rt-canada.ca",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "sksmith",
+      "name": "Sean K Smith",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/2085441?v=4",
+      "profile": "http://seanksmith.me",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kneely",
+      "name": "Kevin Neely",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/37545028?v=4",
+      "profile": "https://www.linkedin.com/in/kevin-neely/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "ariefrahmansyah",
+      "name": "Arief Rahmansyah",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/8122852?v=4",
+      "profile": "https://ariefrahmansyah.dev",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "vHanda",
+      "name": "Vishesh Handa",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/426467?v=4",
+      "profile": "http://vhanda.in",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "HeroicHitesh",
+      "name": "Hitesh Kumar",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/37622734?v=4",
+      "profile": "http://www.linkedin.com/in/heroichitesh",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "spencerwooo",
+      "name": "Spencer Woo",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/32114380?v=4",
+      "profile": "https://spencerwoo.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "ingalless",
+      "name": "ingalless",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/22981941?v=4",
+      "profile": "https://ingalless.com",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "jmg-duarte",
+      "name": "José Duarte",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/15343819?v=4",
+      "profile": "http://jmg-duarte.github.io",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "yenly",
+      "name": "Yenly",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/6759658?v=4",
+      "profile": "https://www.yenly.wtf",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "hikerpig",
+      "name": "hikerpig",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/2259688?v=4",
+      "profile": "https://www.hikerpig.cn",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Sigfried",
+      "name": "Sigfried Gold",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1586931?v=4",
+      "profile": "http://sigfried.org",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "tristansokol",
+      "name": "Tristan Sokol",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/867661?v=4",
+      "profile": "http://www.tristansokol.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "umbrellait-danil-rodin",
+      "name": "Danil Rodin",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/49779373?v=4",
+      "profile": "https://umbrellait.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "scott-joe",
+      "name": "Scott Williams",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/2026866?v=4",
+      "profile": "https://www.linkedin.com/in/scottjoewilliams/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Jackiexiao",
+      "name": "jackiexiao",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/18050469?v=4",
+      "profile": "https://jackiexiao.github.io/blog",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "jbn",
+      "name": "John B Nelson",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/78835?v=4",
+      "profile": "https://generativist.substack.com/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "asifm",
+      "name": "Asif Mehedi",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/3958387?v=4",
+      "profile": "https://github.com/asifm",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "litanlitudan",
+      "name": "Tan Li",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/4970420?v=4",
+      "profile": "https://github.com/litanlitudan",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ShaunaGordon",
+      "name": "Shauna Gordon",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/579361?v=4",
+      "profile": "http://shaunagordon.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "MCluck90",
+      "name": "Mike Cluck",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1753801?v=4",
+      "profile": "https://mcluck.tech",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "bpugh",
+      "name": "Brandon Pugh",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/684781?v=4",
+      "profile": "http://brandonpugh.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "themaxdavitt",
+      "name": "Max Davitt",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/27709025?v=4",
+      "profile": "https://max.davitt.me",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "anglinb",
+      "name": "Brian Anglin",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/2637602?v=4",
+      "profile": "http://briananglin.me",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "elswork",
+      "name": "elswork",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1455507?v=4",
+      "profile": "http://deft.work",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "leonhfr",
+      "name": "léon h",
+      "avatar_url": "https://avatars.githubusercontent.com/u/19996318?v=4",
+      "profile": "http://leonh.fr/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "njnygaard",
+      "name": "Nikhil Nygaard",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4606342?v=4",
+      "profile": "https://nygaard.site",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "nitwit-se",
+      "name": "Mark Dixon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1382124?v=4",
+      "profile": "http://www.nitwit.se",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "joeltjames",
+      "name": "Joel James",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3732400?v=4",
+      "profile": "https://github.com/joeltjames",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ryo33",
+      "name": "Hashiguchi Ryo",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8780513?v=4",
+      "profile": "https://www.ryo33.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "movermeyer",
+      "name": "Michael Overmeyer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1459385?v=4",
+      "profile": "https://movermeyer.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "derrickqin",
+      "name": "Derrick Qin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3038111?v=4",
+      "profile": "https://github.com/derrickqin",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "zomars",
+      "name": "Omar López",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3504472?v=4",
+      "profile": "https://www.linkedin.com/in/zomars/",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "RobinKing",
+      "name": "Robin King",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1583193?v=4",
+      "profile": "http://robincn.com",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "dheepakg",
+      "name": "Dheepak ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4730170?v=4",
+      "profile": "http://twitter.com/deegovee",
+      "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"
+      ]
     }
   ],
-  "contributorsPerLine": 7
+  "contributorsPerLine": 7,
+  "skipCi": true
 }

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "import"],
+  "rules": {
+    "@typescript-eslint/class-name-casing": "warn",
+    "@typescript-eslint/semi": "warn",
+    "curly": "warn",
+    "eqeqeq": "warn",
+    "no-throw-literal": "warn",
+    "semi": "off",
+    "require-await": "warn"
+  }
+}

.github/ISSUE_TEMPLATE/bug.md

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

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question
+    url: https://foambubble.github.io/join-discord/g
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature.md

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

.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - name: Restore Dependencies and VS Code test instance
+        uses: actions/cache@v2
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+            packages/foam-vscode/.vscode-test
+          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
+        run: yarn lint
+
+  test:
+    name: Build and Test
+    strategy:
+      matrix:
+        os: [macos-10.15, ubuntu-18.04, windows-2019]
+    runs-on: ${{ matrix.os }}
+    env:
+      OS: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - name: Restore Dependencies and VS Code test instance
+        uses: actions/cache@v2
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+            packages/foam-vscode/.vscode-test
+          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.4
+        with:
+          run: yarn test

.gitignore

@@ -4,4 +4,8 @@ node_modules
 *.tsbuildinfo
 *.vsix
 *.log
+out
 dist
+docs/_site
+docs/.sass-cache
+docs/.jekyll-metadata

.vscode/launch.json

@@ -3,47 +3,29 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-             // This task is also defined in packages/foam-vscode/.vscode/launch.json
-             // for when running separately outside of the monorepo environment
-			"name": "Run Extension",
-            "type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}/packages/foam-vscode"
-			],
-			"outFiles": [
-				"${workspaceFolder}/packages/foam-vscode/out/**/*.js"
-			],
-			"preLaunchTask": "Build foam-vscode"
-		},
-		{
-            // This task is also defined in packages/foam-vscode/.vscode/launch.json
-            // for when running separately outside of the monorepo environment
-			"name": "Extension Tests",
-			"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": "Build foam-vscode"
-		},
-		{
-			"type": "node",
-			"request": "launch",
-			"name": "Workspace Manager tests",
-			"program": "${workspaceFolder}/node_modules/tsdx/dist/index.js",
-			"args": ["test"],
-			"cwd": "${workspaceFolder}/packages/foam-core",
-			"internalConsoleOptions": "openOnSessionStart"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "name": "Debug Jest Tests",
+      "request": "launch",
+      "runtimeArgs": ["workspace", "foam-vscode", "run", "test"], // ${yarnWorkspaceName} is what we're missing
+      "args": ["--runInBand"],
+      "runtimeExecutable": "yarn",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "disableOptimisticBPs": true
+    },
+    {
+      "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}"
+    }
+  ]
 }

.vscode/settings.json

@@ -1,15 +1,32 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-    "files.exclude": {
-        // set these to true to hide folders with the compiled JS files,
-        "packages/**/out": false,
-        "packages/**/dist": false
-    },
-    "search.exclude": {
-        // set this to false to include compiled JS folders in search results
-        "packages/**/out": true, 
-        "packages/**/dist": true
-    },
-    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
-}
+  "files.exclude": {
+    // set these to true to hide folders with the compiled JS files,
+    "packages/**/out": false,
+    "packages/**/dist": false
+  },
+  "search.exclude": {
+    // set this to false to include compiled JS folders in search results
+    "packages/**/out": true,
+    "packages/**/dist": true
+  },
+  // 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/**/*",
+    "packages/**/*"
+  ],
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "prettier.requireConfig": true,
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2,
+  "jest.debugCodeLens.showWhenTestStateIn": ["fail", "unknown", "pass"],
+  "gitdoc.enabled": false,
+  "jest.autoEnable": false,
+  "jest.runAllTestsFirst": false,
+  "search.mode": "reuseEditor"
+}

.vscode/tasks.json

@@ -1,22 +1,31 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-            // This task is also defined in packages/foam-vscode/.vscode/tasks.json
-            // for when running separately outside of the monorepo environment
-            "type": "npm",
-            "script": "watch",
-            "label": "Build foam-vscode",
-            "path": "packages/foam-vscode",
-            "problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "silent",
-				"revealProblems": "onProblem",
-				"focus": 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
+      }
+    }
+  ]
 }

CONTRIBUTING.md

@@ -1,14 +0,0 @@
-# Contributing
-
-Hello, friend.
-
-This repository is a [monorepo](https://en.wikipedia.org/wiki/Monorepo) managed by [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
-
-- The [packages](packages/) directory contains all Foam core code packages
-- The [docs](docs/) directory contains a Foam workspace that hosts the official [documentation site](https://foambubble.github.io/foam)
-
-The foam starter template lives outside of this repository at [foambubble/foam-template](https://github.com/foambubble/foam-template).
-
-See [Foam Contribution Guide](https://foambubble.github.io/foam/contribution-guide) on the rendered Foam workspace for more information on how to contribute to Foam.
-
-Thank you for your interest!

LICENSE

@@ -1,6 +1,6 @@
 The MIT Licence (MIT)
 
-Copyright 2020 Jani Eväkallio <jani.evakallio@gmail.com>
+Copyright 2020 - present Jani Eväkallio <jani.evakallio@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -17,4 +17,17 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Where noted, some code uses the following license:
+
+MIT License
+
+Copyright (c) 2015 - present Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:

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/.vscode/settings.json

@@ -4,7 +4,8 @@
   "editor.wrappingIndent": "indent",
   "editor.overviewRulerBorder": false,
   "editor.lineHeight": 24,
-  "workbench.colorTheme": "Gray Matter Light",
+  "foam.edit.linkReferenceDefinitions": "withExtensions",
+  "vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
   "[markdown]": {
     "editor.quickSuggestions": {
       "other": true,
@@ -14,5 +15,15 @@
   },
   "cSpell.language": "en-GB",
   "git.enableSmartCommit": true,
-  "git.postCommitCommand": "sync"
+  "git.postCommitCommand": "sync",
+  "spellright.language": [
+    "en"
+  ],
+  "spellright.documentTypes": [
+    "markdown",
+    "plaintext"
+  ],
+  "files.exclude": {
+    "_site/**": true
+  }
 }

docs/.vscode/spellright.dict

@@ -0,0 +1 @@
+Backlinking

docs/404.md

@@ -0,0 +1,12 @@
+# Page not found!
+
+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

docs/Gemfile

@@ -0,0 +1,37 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+# gem "jekyll", "~> 3.9.0"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+gem "github-pages", "~> 209", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
+
+# kramdown v2 ships without the gfm parser by default. If you're using
+# kramdown v1, comment out this line.
+gem "kramdown-parser-gfm"

docs/Gemfile.lock

@@ -0,0 +1,272 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    commonmarker (0.17.13)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.7)
+    dnsruby (1.61.5)
+      simpleidn (~> 0.1)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    eventmachine (1.2.7)
+    execjs (2.7.0)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    gemoji (3.0.1)
+    github-pages (209)
+      github-pages-health-check (= 1.16.1)
+      jekyll (= 3.9.0)
+      jekyll-avatar (= 0.7.0)
+      jekyll-coffeescript (= 1.1.1)
+      jekyll-commonmark-ghpages (= 0.1.6)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.15.1)
+      jekyll-gist (= 1.5.0)
+      jekyll-github-metadata (= 2.13.0)
+      jekyll-mentions (= 1.6.0)
+      jekyll-optional-front-matter (= 0.3.2)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.3.0)
+      jekyll-redirect-from (= 0.16.0)
+      jekyll-relative-links (= 0.6.1)
+      jekyll-remote-theme (= 0.4.2)
+      jekyll-sass-converter (= 1.5.2)
+      jekyll-seo-tag (= 2.6.1)
+      jekyll-sitemap (= 1.4.0)
+      jekyll-swiss (= 1.0.0)
+      jekyll-theme-architect (= 0.1.1)
+      jekyll-theme-cayman (= 0.1.1)
+      jekyll-theme-dinky (= 0.1.1)
+      jekyll-theme-hacker (= 0.1.2)
+      jekyll-theme-leap-day (= 0.1.1)
+      jekyll-theme-merlot (= 0.1.1)
+      jekyll-theme-midnight (= 0.1.1)
+      jekyll-theme-minimal (= 0.1.1)
+      jekyll-theme-modernist (= 0.1.1)
+      jekyll-theme-primer (= 0.5.4)
+      jekyll-theme-slate (= 0.1.1)
+      jekyll-theme-tactile (= 0.1.1)
+      jekyll-theme-time-machine (= 0.1.1)
+      jekyll-titles-from-headings (= 0.5.3)
+      jemoji (= 0.12.0)
+      kramdown (= 2.3.0)
+      kramdown-parser-gfm (= 1.1.0)
+      liquid (= 4.0.3)
+      mercenary (~> 0.3)
+      minima (= 2.5.1)
+      nokogiri (>= 1.10.4, < 2.0)
+      rouge (= 3.23.0)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.16.1)
+      addressable (~> 2.3)
+      dnsruby (~> 1.60)
+      octokit (~> 4.0)
+      public_suffix (~> 3.0)
+      typhoeus (~> 1.3)
+    html-pipeline (2.14.0)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.9.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (>= 1.17, < 3)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-avatar (0.7.0)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-coffeescript (1.1.1)
+      coffee-script (~> 2.2)
+      coffee-script-source (~> 1.11.1)
+    jekyll-commonmark (1.3.1)
+      commonmarker (~> 0.14)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-commonmark-ghpages (0.1.6)
+      commonmarker (~> 0.17.6)
+      jekyll-commonmark (~> 1.2)
+      rouge (>= 2.0, < 4.0)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.15.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-gist (1.5.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.13.0)
+      jekyll (>= 3.4, < 5.0)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.6.0)
+      html-pipeline (~> 2.3)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-optional-front-matter (0.3.2)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-paginate (1.1.0)
+    jekyll-readme-index (0.3.0)
+      jekyll (>= 3.0, < 5.0)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-relative-links (0.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-remote-theme (0.4.2)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-swiss (1.0.0)
+    jekyll-theme-architect (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-cayman (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-dinky (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-hacker (0.1.2)
+      jekyll (> 3.5, < 5.0)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-leap-day (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-merlot (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-midnight (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-minimal (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-modernist (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-primer (0.5.4)
+      jekyll (> 3.5, < 5.0)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-slate (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-tactile (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-theme-time-machine (0.1.1)
+      jekyll (~> 3.5)
+      jekyll-seo-tag (~> 2.0)
+    jekyll-titles-from-headings (0.5.3)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    jemoji (0.12.0)
+      gemoji (~> 3.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0, < 5.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.3.3)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    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.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    octokit (4.19.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.1.1)
+    racc (1.5.2)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.23.0)
+    ruby-enum (0.8.0)
+      i18n
+    ruby2_keywords (0.0.2)
+    rubyzip (2.3.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    simpleidn (0.1.1)
+      unf (~> 0.1.4)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2020.4)
+      tzinfo (>= 1.0.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    wdm (0.1.1)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages (~> 209)
+  jekyll-feed (~> 0.6)
+  kramdown-parser-gfm
+  minima (~> 2.0)
+  tzinfo (~> 1.2)
+  tzinfo-data
+  wdm (~> 0.1.0)
+
+BUNDLED WITH
+   2.1.2

docs/LICENSE.txt

@@ -0,0 +1,33 @@
+The MIT Licence (MIT)
+
+Copyright 2020 - present Jani Eväkallio <jani.evakallio@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Where noted, some code uses the following license:
+
+MIT License
+
+Copyright (c) 2015 - present Microsoft Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:

docs/_layouts/foam.html

@@ -0,0 +1,52 @@
+---
+layout: default
+---
+
+<script type="text/javascript">
+// NOTE: this should be in sync with the settings/usage in the vscode extension
+// atm it's just a wide superset of md extensions to cover a wide range of cases
+var MD_EXT = ['.md', '.markdown', '.mdx', '.mdown', '.mkdn', '.mkd', '.mdwn', '.mdtxt', '.mdtext', '.text', '.Rmd'];
+function normalizeMdLink(link) {
+  var url = new URL(link);
+  var mdFileExt = MD_EXT.find(ext => url.pathname.endsWith(ext));
+  if (mdFileExt) {
+    url.pathname = url.pathname.slice(0, mdFileExt.length * -1);
+  }
+  return url.toString();
+}
+
+window.addEventListener('DOMContentLoaded', (event) => {
+  document
+    .querySelectorAll(".markdown-body a[title]:not([href^=http])")
+    .forEach((a) => {
+      // filter to only wikilinks
+      var prev = a.previousSibling;
+      var next = a.nextSibling;
+      if (
+        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;
+
+        // ...and normalize the links to allow html pages navigation
+        a.href = normalizeMdLink(a.href);
+      }
+    });
+
+  document.querySelectorAll(".github-only").forEach((el) => {
+    el.remove();
+  });
+});
+</script>
+
+
+{{ content }}

docs/_layouts/home.html

@@ -1,25 +1,16 @@
 ---
-layout: default
+layout: foam
 ---
 
 <script async defer src="https://buttons.github.io/buttons.js"></script>
 
 {{ content }}
 
-<script type="text/javascript">
-  // Hack: Replace page-link with "Page Title"
-  document
-    .querySelectorAll(".markdown-body a[title]:not([href^=http])")
-    .forEach((a) => {
-      a.innerText = a.title;
-    });
-
-  document.querySelectorAll(".github-only").forEach((el) => {
-    el.remove();
-  });
-
+<script>
+window.addEventListener('DOMContentLoaded', (event) => {
   var duplicateHeading = document.querySelector("h1:not(#foam)");
   if (duplicateHeading && duplicateHeading.remove) {
     duplicateHeading.remove();
   }
+});
 </script>

docs/_layouts/mathjax.html

@@ -0,0 +1,15 @@
+---
+layout: foam
+---
+
+{{ content }}
+
+<script src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+<script type="text/x-mathjax-config">
+    MathJax.Hub.Config({
+        tex2jax: {
+            skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
+            inlineMath: [['$','$']]
+        }
+    });
+</script>

docs/_layouts/page.html

@@ -1,18 +1,5 @@
 ---
-layout: default
+layout: foam
 ---
 
 {{ content }}
-
-<script type="text/javascript">
-  // Hack: Replace page-link with "Page Title"
-  document
-    .querySelectorAll(".markdown-body a[title]:not([href^=http])")
-    .forEach((a) => {
-      a.innerText = a.title;
-    });
-
-  document.querySelectorAll(".github-only").forEach((el) => {
-    el.remove();
-  });
-</script>

docs/assets/css/style.scss

@@ -52,6 +52,16 @@ blockquote {
     "DejaVu Serif", "Bitstream Vera Serif", "Liberation Serif", Georgia, serif;
 }
 
+.wikilink:before {
+  content: "[[";
+  opacity: 0.5;
+}
+
+.wikilink:after {
+  content: "]]";
+  opacity: 0.5;
+}
+
 .github-only {
   display: none;
 }

docs/assets/images/diagram-drawio-demo.drawio.svg

@@ -0,0 +1,68 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="281px" height="181px" viewBox="-0.5 -0.5 281 181" content="&lt;mxfile host=&quot;dd26700e-36c4-4a92-a6df-21c7be0d8350&quot; modified=&quot;2020-08-31T10:44:14.509Z&quot; agent=&quot;5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Code/1.48.2 Chrome/78.0.3904.130 Electron/7.3.2 Safari/537.36&quot; etag=&quot;ygaBEVmOlivkHZFzXaxy&quot; version=&quot;13.1.3&quot;&gt;&lt;diagram id=&quot;6hGFLwfOUW9BJ-s0fimq&quot; name=&quot;Page-1&quot;&gt;1ZVNT4NAEIZ/DVdT2NrWq7XqQU89aI+bMsKahSHboYC/3qXMAhvUmJi08QTzzMcy72yGQKyz+sHIIn3GGHQQzeI6EHdBFIXLcGUfLWmYhMvrjiRGxcwGsFUfwHDGtFQxHLxAQtSkCh/uMc9hTx6TxmDlh72h9k8tZAITsN1LPaUvKqa0o6toOfBHUEnqTg4XN50nky6YOzmkMsZqhMQmEGuDSN1bVq9Bt+o5Xbq8+2+8/YcZyOk3Caz7gRrXG8S2VTbRUIoJ5lJvBnprsMxjaAvMrDXEPCEWFoYWvgNRw3OTJaFFKWWavVArem3Tr+z5nbkbue5qLn0yGmfkZJou69qZu7FvSDtZLq9rsO3qW4kYHbA0e46K+FZJkwBHiX489mIDZmBPsSEGtCR19KtLvmBJHzfMwL7wGL4eyeKyI1n+o5HMzzQSPvoodekXHQ3JH0GVKoJtIU8fX9k16MvN9cAQ1D9rMO2OE6I5rxC3RN1KqYaN1LN0tI0Ws78LIiaCRBcXJFz4gvQCnUOQ+UQQcXFBRHQ+Qaw5/LROvtG/X2w+AQ==&lt;/diagram&gt;&lt;/mxfile&gt;">
+    <defs/>
+    <g>
+        <path d="M 110 60 L 110 90 L 60 90 L 60 113.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/>
+        <path d="M 60 118.88 L 56.5 111.88 L 60 113.63 L 63.5 111.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/>
+        <path d="M 170 60 L 170 90 L 220 90 L 220 113.63" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/>
+        <path d="M 220 118.88 L 216.5 111.88 L 220 113.63 L 223.5 111.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/>
+        <rect x="80" y="0" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/>
+        <g transform="translate(-0.5 -0.5)">
+            <switch>
+                <foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
+                    <div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 30px; margin-left: 81px;">
+                        <div style="box-sizing: border-box; font-size: 0; text-align: center; ">
+                            <div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">
+                                1
+                            </div>
+                        </div>
+                    </div>
+                </foreignObject>
+                <text x="140" y="34" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">
+                    1
+                </text>
+            </switch>
+        </g>
+        <rect x="0" y="120" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/>
+        <g transform="translate(-0.5 -0.5)">
+            <switch>
+                <foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
+                    <div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 150px; margin-left: 1px;">
+                        <div style="box-sizing: border-box; font-size: 0; text-align: center; ">
+                            <div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">
+                                2
+                            </div>
+                        </div>
+                    </div>
+                </foreignObject>
+                <text x="60" y="154" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">
+                    2
+                </text>
+            </switch>
+        </g>
+        <rect x="160" y="120" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/>
+        <g transform="translate(-0.5 -0.5)">
+            <switch>
+                <foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility">
+                    <div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 150px; margin-left: 161px;">
+                        <div style="box-sizing: border-box; font-size: 0; text-align: center; ">
+                            <div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">
+                                3
+                            </div>
+                        </div>
+                    </div>
+                </foreignObject>
+                <text x="220" y="154" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">
+                    3
+                </text>
+            </switch>
+        </g>
+    </g>
+    <switch>
+        <g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/>
+        <a transform="translate(0,-5)" xlink:href="https://desk.draw.io/support/solutions/articles/16000042487" target="_blank">
+            <text text-anchor="middle" font-size="10px" x="50%" y="100%">
+                Viewer does not support full SVG 1.1
+            </text>
+        </a>
+    </switch>
+</svg>

docs/automatic-git-syncing.md

@@ -1,11 +0,0 @@
-# Automatic Git Syncing (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

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]: todo "Todo"
+[todo]: dev/todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/block-references.md

@@ -1,10 +0,0 @@
-# Block References (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/blog.md

@@ -1,7 +0,0 @@
-# Foam Blog
-
-- [[2020-07-11-three-weeks-in]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[2020-07-11-three-weeks-in]: blog/2020-07-11-three-weeks-in "Three Weeks In"
-[//end]: # "Autogenerated link references"

docs/blog/2020-07-11-three-weeks-in.md

@@ -1,3 +0,0 @@
-# Three Weeks In
-
-Todo

docs/code-of-conduct.md

@@ -61,7 +61,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at `jani.evakallio+foam@gmail.com`.
+reported to the community leaders responsible for enforcement at `riki.code+foam@gmail.com`.
 
 All complaints will be reviewed and investigated promptly and fairly.
 
@@ -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,9 +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.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[//end]: # "Autogenerated link references"
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

docs/contributing.md

@@ -1,7 +0,0 @@
-# Contributing
-
-Head over to the [[contribution-guide]]. `CONTRIBUTING.md` file name is blocklisted on GitHub pages, and doesn't appear in the [rendered output](https://foambubble.github.io/foam).
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[//end]: # "Autogenerated link references"

docs/contribution-guide.md

@@ -1,25 +1,29 @@
+---
+tags: todo, good-first-task
+---
 # Contribution Guide
 
-> [[todo]] [[good-first-task]] This contribution guide itself could be improved 😅
+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.
 
-Foam is open to contributions of any kind, including but not limited to code, documentation, ideas and feedback. Here are some general tips on how to get started on contributing to Foam:
+## Getting Up To Speed
 
-- Use Foam for yourself, figure out what could be improved.
-- Check out [[roadmap]] to see what's already in the plans. I have thoughts about how to implement some of these, but open to ideas and code contributions!
-- Read about our [[principles]] to understand Foam's philosophy and direction
-- Read and act in accordance of our [[code-of-conduct]].
-- Feel free to open [GitHub issues](https://github.com/foambubble/foam/issues) to give me feedback and ideas for new features.
-- Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/)
-  - [/docs](https://github.com/foambubble/foam/docs): documentation and [[recipes]]
-  - [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode): the core VSCode plugin
-  - [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core): powers the core functionality in Foam across all platforms
-- 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.
+Before you start contributing we recommend that you read the following links:
 
-## Contributing to the VS Code Extension
+- [[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!
 
-If you're interested in contributing to the VS Code extension (aka `foam-vscode`), this guide will help you get things set up locally.
+## Diving In
+
+We understand that diving in an unfamiliar codebase may seem scary,
+to make it easier for new contributors we provide some resources:
+
+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)!
+
+## Contributing
+
+If you're interested in contributing, this short guide will help you get things set up locally.
 
 1. Clone the repo locally:
 
@@ -29,25 +33,68 @@ If you're interested in contributing to the VS Code extension (aka `foam-vscode`
 
    `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 workspace foam-core build`
+   `yarn build`
 
-4. 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.
-5. 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). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.
-6. 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!
+You should now be ready to start working!
 
-For more resources related to the VS Code Extension, check out the links below:
+### Structure of the project
 
-- [[tutorial-adding-a-new-command-to-the-vs-code-extension]]
+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
+
+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. 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!
+
+---
+
+Feel free to modify and submit a PR if this guide is out-of-date or contains errors!
+
+---
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[good-first-task]: good-first-task "Good First Task"
-[roadmap]: roadmap "Roadmap"
-[principles]: principles "Principles"
-[code-of-conduct]: code-of-conduct "Code of Conduct"
-[recipes]: recipes "Recipes"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[tutorial-adding-a-new-command-to-the-vs-code-extension]: tutorial-adding-a-new-command-to-the-vs-code-extension "Tutorial: Adding a New Command to the VS Code Extension"
+[principles]: principles.md "Principles"
+[code-of-conduct]: code-of-conduct.md "Code of Conduct"
+[recipes]: recipes/recipes.md "Recipes"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
 [//end]: # "Autogenerated link references"

docs/creating-a-new-language.md

@@ -1,11 +0,0 @@
-## Creating a new language
-
-What if we created a new language that made it more ergonomic to use VS Code as a Foam workspace
-
-- Based on markdown
-- Could leverage mdx?
-- Shortcuts, like links between pages
-- Downside: Not markdown compatible, not so good for other tools
-  - Could it be a markdown superset?
-  - Or a language that transpiles to markdown and back, so it can be edited in "Foam" format and committed in MD so it's viewable on GH as markdown
-    - How imporant is it that links are navigable on GH? I guess it is

docs/creating-new-notes.md

@@ -1,11 +0,0 @@
-# Creating New Notes
-
-- Write out a new `[[wiki-link]]` and `Cmd` + `Click` to create a new file.
-- `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`
-  - Add a keyboard binding to make creating new notes easier.
-- You shouldn't worry too much about categorising 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]: search-for-notes "Search for Notes"
-[graph-visualisation]: graph-visualisation "Graph visualisation"
-[//end]: # "Autogenerated link references"

docs/custom-markdown-preview-styles.md

@@ -1,15 +0,0 @@
-# Custom Markdown Preview Styles
-
-Visual Studio Code allows you to use your own CSS in the Markdown preview tab.
-
-## Instructions
-
-Custom CSS for the Markdown preview can be implemented by using the `"markdown.styles": []` setting in `settings.json`. The stylesheets can either be https URLs or relative paths to local files in the current workspace.
-
-For example, to load a stylesheet called `Style.css`, we can update `settings.json` with the following line:
-
-```
-{
-  "markdown.styles": ["Style.css"]
-}
-```

docs/customising-styles.md

@@ -1,10 +0,0 @@
-# Customising Styles
-
-You can edit `assets/css/style.scss` to change how published pages look.
-
-[[todo]] [[good-first-task]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[good-first-task]: good-first-task "Good First Task"
-[//end]: # "Autogenerated link references"

docs/daily-notes.md

@@ -1,36 +0,0 @@
-# Daily notes
-
-The idea is to make it easier for people to be able to create Daily notes.
-
-This feature is open for discussion at [foambubble/foam#54](https://github.com/foambubble/foam/issues/54).
-
-## Must have
-
-- Should exist as part of [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension 
-- A new command "Foam: Open Daily Note", which creates new file and focuses into it, or opens the existing file for today if it exists already.
-  - File should have a Level 1 `# Heading`
-- Extension should define a hotkey for it (TBD? What do other apps do?)
-
-## Should have
-
-- Settings to customise:
-  - Format of file name, default to `yyyy-mm-dd`
-  - Format of title
-    - Default to same as file name
-    - Allow override e.g. `MMMMM D, YYYY`, to July 8. 2020 (locale specific)
-  - Extension of file, default to `.md`
-  - Directory into which file should be created, default to `./` (workspace root)
-    - Should create directory if needed
-
-## Could have
-- Automatically update a "daily notes" index file, newest first. Format TBD
-  - A custom note template .md file that could be stored in `.vscode/` directory (would supercede having to format the title)
-    - This could be useful for people who e.g. want there to be a format for every day's notes with fixed questions and stuff.
-  - Maybe we could do it with just back links or tags, by putting e.g. `[[daily]]` into the note template
-  - If files were named in alphabetic sortable order, and back links would display in reverse order, newest would always come on top
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"
-

docs/decision-needed.md

@@ -1,3 +0,0 @@
-# Decision Needed
-
-Check backlinks

docs/decision.md

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

docs/dev/build-vs-assemble.md

@@ -10,7 +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.
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[referencing-notes-by-title]: referencing-notes-by-title "Referencing notes by title"
-[//end]: # "Autogenerated link references"

docs/dev/foam-core.md

@@ -17,10 +17,10 @@
 `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
+    - 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
 - Treat each file as semi-structured data
   - Title, headings, lists, paragraphs, images, links, data, code
   - Also, possible Foam-specific meta stuff, like "backlinks" or "block references".
@@ -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]]
-  - [[wiki-links]] reference definitions
+  - [[link-reference-definitions]] for [[wikilinks]]
   - [Frontmatter](https://jekyllrb.com/docs/front-matter/)
 - Finding all documents with `#tag`
 - Finding all documents with instances of `[[link]]`
@@ -96,12 +96,12 @@ Useful for knowing what needs to be supported. See [[feature-comparison]].
 - [[foam-core-2020-07-11]]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[workspace-janitor]: workspace-janitor "Workspace Janitor"
-[cli]: cli "Command Line Interface"
-[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
-[wiki-links]: wiki-links "Wiki Links"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
-[todo]: todo "Todo"
-[feature-comparison]: feature-comparison "Feature comparison"
-[foam-core-2020-07-11]: meeting-notes/foam-core-2020-07-11 "Foam Core 2020-07-11"
+[workspace-janitor]: ../features/workspace-janitor.md "Janitor"
+[cli]: ../features/cli.md "Command Line Interface"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
+[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"
+[foam-core-2020-07-11]: ../meeting-notes/foam-core-2020-07-11.md "Foam Core 2020-07-11"
 [//end]: # "Autogenerated link references"

docs/dev/foam-file-format.md

@@ -0,0 +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 `[[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 `[[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 `[[MediaWiki]]` links.** See [[wikilinks]] for more details.
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[wikilinks]: ../wikilinks.md "Wikilinks"
+[//end]: # "Autogenerated link references"

docs/dev/good-first-task.md

@@ -5,5 +5,5 @@ See the backlinks of this page for good first contribution opportunities.
 [[materialized-backlinks]] would help here.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

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

@@ -0,0 +1,143 @@
+# Link Reference Definition Improvements
+
+## Current Problems
+
+### File-by-file Insertion
+
+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 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.
+
+So, why don't they work on GitHub?
+
+The three components of [[link-reference-definitions]] are link label, link destination and Link Title.
+
+The issue is the middle **link destination** component. It's configured to point to the file name **without file extension**, i.e. "file-name" instead of "file-name.md". This is to make the GitHub Pages rendering work, because if we generated the links to `file-name.md`, the links would point to the raw markdown files instead of their generated HTML versions.
+
+| Environment      | `file-name` | `file-name.md` |
+| ---------------- | ----------- | -------------- |
+| **VS Code**      | Works       | Works          |
+| **GitHub pages** | Works       | Breaks         |
+| **GitHub UI**    | Breaks      | Works          |
+
+So as you can see, we've prioritised GitHub Pages over GitHub Web UI for the time being.
+
+Ideally, we'd like a solution that works with both, but it's not defined yet (see [[link-reference-definitions]] for more details)
+
+#### Workaround
+
+For the time being, you can use relative `[markdown links](markdown-link.md)` syntax.
+
+**Pros:**
+
+- This will work on all platforms.
+
+**Cons:**
+
+- It will break the Markdown Notes [[backlinking]] support
+- Less convenient to write
+
+### Finding certain words clutter the VS Code search results
+
+Since link reference definitions have `[//begin]` and `[//end]` guards with explanatory text that use certain words, these words (like "generate") appear in VS Code search results if you happen to search matching strings from the workspace.
+
+## Improvement Proposal
+
+Problem space in essence:
+
+- During edit-time (when modifying the markdown files in an editor)
+  - link reference definitions are needed if user uses editor extensions that don't understand wikilinks
+  - link reference definitions may be annoying since they
+    - add content to files that the user hasn't typed in by themselves
+    - get out of date if user uses a tool that doesn't autogenerate them
+    - 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)
+
+The potential solution:
+
+- For edit-time
+  - Make edit-time link reference definition generation optional via user settings. They should be on by default, and generating valid markdown links with a relative path to a `.md` file.
+  - Make format of the link reference definition configurable (whether to include '.md' or not)
+  - Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/master/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
+- For build-time
+  - To satisfy mutually incompatible constraints between GitHub UI, VSCode UI, and GitHub Pages, we should add a pre-processing/build step for pushing to GitHub Pages.
+    - 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
+    {
+      "foam": {
+        "publish": [
+          {
+            "name": "Gitlab Mirror",     // name of the publish target
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "withExtensions"
+          },
+          {
+            "name": "GitHub Pages",
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "withoutExtensions"
+          },
+          {
+            "name": "Blog",
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "Off"
+          },
+          {
+            "name": "My Amazing PDF book",
+            "linkTranspilation": "WikiLinksToMarkdown"
+          }
+        ],
+        "edit": {
+          "linkReferenceDefinitions": "Off"
+        }
+      }
+    }
+
+    // Defines if and how links in markdown files are somehow converted (in-place) during build time
+    // Note that this enumeration is not valid edit-time, since we (probably) don't want to change text like this while user is editing it
+    enum LinkTranspilation {
+      Off,                   // links are not transpiled
+      WikiLinksToMarkdown,   // links using wiki-format [[link]] are converted to normal md links: [link](./some/file.md)
+                             // if this is set, not link reference definitions are generated (not needed)
+    }
+
+    // Defines if and how link reference definition section is generated
+    enum LinkReferenceDefinitions {
+      Off,               // link reference definitions are not generated
+      WithExtensions,    // link reference definitions contain .md (or similar) file extensions
+      WithoutExtensions  // link reference definitions do not contain file extenions
+    }
+
+    ```
+
+  - 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).
+
+Note that the proposal above supports both (build-time) inline transpilation of wikilinks as well as creation reference definitions. Depending on the direction of Foam, also only one of them could be selected. In that case the other could be implemented at later point of time.
+
+UI-wise, the publish targets could be picked in some similar fashion as the run/debug targets in vscode by implementing a separate panel, or maybe through command execution (CTRL+SHIFT+P) - not yet defined at this point.
+
+## Links
+
+- [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[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

@@ -1,6 +1,6 @@
 # Materialized Backlinks (stub)
 
-**[[todo]] This [[roadmap]] item needs more specification work.** 
+**[[todo]] This [[roadmap]] item needs more specification work.**
 
 If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
 
@@ -12,6 +12,6 @@ The idea would be to automatically generate lists of backlinks (and optionally,
 - Make Foam notes more portable to different apps and long-term storage
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"
+[todo]: todo.md "Todo"
+[roadmap]: roadmap.md "Roadmap"
+[//end]: # "Autogenerated link references"

docs/dev/mdx-by-default.md

@@ -1,10 +1,10 @@
 # MDX by Default(stub)
 
-**[[todo]] This [[roadmap]] item needs more specification work.** 
+**[[todo]] This [[roadmap]] item needs more specification work.**
 
 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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"
+[todo]: todo.md "Todo"
+[roadmap]: roadmap.md "Roadmap"
+[//end]: # "Autogenerated link references"

docs/dev/publishing-permissions.md

@@ -1,6 +1,6 @@
 # Publishing Permissions(stub)
 
-**[[todo]] This [[roadmap]] item needs more specification work.** 
+**[[todo]] This [[roadmap]] item needs more specification work.**
 
 If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
 
@@ -10,6 +10,6 @@ If you're interested in working on it, please start a conversation in [GitHub is
 - Share specific page (with private hash)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"
+[todo]: todo.md "Todo"
+[roadmap]: roadmap.md "Roadmap"
+[//end]: # "Autogenerated link references"

docs/dev/roadmap.md

@@ -6,16 +6,12 @@ Some of these items can be achieved by combining existing tools, but others may
 
 Items that are already being worked on. Roadmap items in this stage should have an owner.
 
-- [@jevakallio](https://github.com/jevakallio): [[cli]]
-
 ## High priority
 
 Items we plan on working next. Items in this stage don't need to have an owner, but before we start working on them should have enough specification that they can be picked up and worked on without having to seek consensus.
 
 If you want to pick up work in this category, you should have a plan on how long the implementation will approximately take so we don't block progress by sitting on high priority issues.
 
-- [[workspace-janitor]]
-  
 ## Backlog
 
 Everything else, categorised into themes. Just because something is on this list doesn't mean it'll get done. If you're interested in working on items in this category, check the [[contribution-guide]] for how to get started.
@@ -27,21 +23,24 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
 ### Known issues
 
 - [[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
 
 - [[renaming-files]]
 - [[unlinked-references]]
-- [[daily-notes]]
 - [[block-references]]
 - [[improved-backlinking]]
   - UX: [[make-backlinks-more-prominent]]
 - [[materialized-backlinks]]
 - [[automatic-git-syncing]]
 - [[git-flows-for-teams]]
+- [[user-settings]]
+- [[link-reference-definitions]]
+- [[predefined-user-snippets]]
 
 ### Publishing
 
@@ -64,51 +63,42 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
 
 ### Migration
 
+The community is working on a number of automated scripts to help you migrate to Foam. The main work of developing such a method involves exporting your notes, converting them to the Markdown format, and then making sure that the links between notes (if you had those) still work.
+
 - [[migrating-from-roam]]
   - Discussion: [foam#55](https://github.com/foambubble/foam/issues/55)
 - [[migrating-from-obsidian]]
   - Discussion: [foam#46](https://github.com/foambubble/foam/issues/46)
+- [[migrating-from-onenote]]
+  - Discussion: [foam#151](https://github.com/foambubble/foam/issues/151)
 - _Migration from other tools..._
 
-### integration
+### Integration
+
 - _Integrations to third party tools_...
-  
+
 ### Wild ideas
 
 - [[foam-linter]]
 - [[refactoring-via-language-server-protocol]]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
-[recipes]: recipes "Recipes"
-[cli]: cli "Command Line Interface"
-[workspace-janitor]: workspace-janitor "Workspace Janitor"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[improve-default-workspace-settings]: improve-default-workspace-settings "Improve Default Workspace Settings (stub)"
-[git-integration]: git-integration "Git integration"
-[wiki-links]: wiki-links "Wiki Links"
-[foam-file-format]: foam-file-format "Foam File Format"
-[renaming-files]: renaming-files "Renaming files (stub)"
-[unlinked-references]: unlinked-references "Unlinked references (stub)"
-[daily-notes]: daily-notes "Daily notes"
-[block-references]: block-references "Block References (stub)"
-[improved-backlinking]: improved-backlinking "Improved Backlinking (stub)"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
-[automatic-git-syncing]: automatic-git-syncing "Automatic Git Syncing (stub)"
-[git-flows-for-teams]: git-flows-for-teams "Git Flows for Teams (stub)"
-[officially-support-alternative-templates]: officially-support-alternative-templates "Officially Support Alternative Templates (stub)"
-[improved-static-site-generation]: improved-static-site-generation "Improved Static Site Generation (stub)"
-[mdx-by-default]: mdx-by-default "MDX by Default(stub)"
-[search-in-published-workspace]: search-in-published-workspace "Search in Published Workspace (stub)"
-[graph-in-published-workspace]: graph-in-published-workspace "Graph in Published Workspace (stub)"
-[linking-between-published-workspaces]: linking-between-published-workspaces "Linking between Published Workspaces (stub)"
-[publishing-permissions]: publishing-permissions "Publishing Permissions(stub)"
-[mobile-apps]: mobile-apps "Mobile Apps"
-[packaged-desktop-app]: packaged-desktop-app "Packaged Desktop App (stub)"
-[web-editor]: web-editor "Web Editor (stub)"
-[migrating-from-roam]: migrating-from-roam "Migrating from Roam (stub)"
-[migrating-from-obsidian]: migrating-from-obsidian "Migrating from Obsidian (stub)"
-[foam-linter]: foam-linter "Foam Linter (stub)"
-[refactoring-via-language-server-protocol]: refactoring-via-language-server-protocol "Refactoring via Language Server Protocol (stub)"
-[make-backlinks-more-prominent]: make-backlinks-more-prominent "Make Backlinks More Prominent"
-[//end]: # "Autogenerated link references"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
+[recipes]: ../recipes/recipes.md "Recipes"
+[contribution-guide]: ../contribution-guide.md "Contribution Guide"
+[git-integration]: ../features/git-integration.md "Git Integration"
+[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"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[automatic-git-syncing]: ../recipes/automatic-git-syncing.md "Automatically Sync with Git"
+[link-reference-definitions]: ../features/link-reference-definitions.md "Link Reference Definitions"
+[predefined-user-snippets]: ../recipes/predefined-user-snippets.md "Pre-defined User Snippets"
+[mdx-by-default]: mdx-by-default.md "MDX by Default(stub)"
+[publishing-permissions]: publishing-permissions.md "Publishing Permissions(stub)"
+[cli]: ../features/cli.md "Command Line Interface"
+[migrating-from-roam]: ../recipes/migrating-from-roam.md "Migrating from Roam (stub)"
+[migrating-from-obsidian]: ../recipes/migrating-from-obsidian.md "Migrating from Obsidian (stub)"
+[migrating-from-onenote]: ../recipes/migrating-from-onenote.md "Migrating from OneNote"
+[//end]: # "Autogenerated link references"

docs/dev/todo.md

@@ -14,6 +14,6 @@ Features belong on the [[roadmap]].
 For more things to do, check backlinks for Pages that annotate [[todo]].
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[roadmap]: roadmap "Roadmap"
-[todo]: todo "Todo"
+[roadmap]: roadmap.md "Roadmap"
+[todo]: todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/dev/unlinked-references.md

@@ -1,20 +1,20 @@
 # Unlinked references (stub)
 
-**[[todo]] This [[roadmap]] item needs more specification work.** 
+**[[todo]] This [[roadmap]] item needs more specification work.**
 
 If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
 
 ## Notes
 
-One of Roam's big features is the ability to find all instances of a reference, create a page for it and update all the references to link to the new page.
+One of Foam's big features is the ability to find all instances of a reference, create a page for it and update all the references to link to the new page.
 
 Implementing this is on the [[roadmap]], but for the time being you can achieve similar things by:
 
 - `Cmd` + `Shift` + `F` ( `Ctrl` + `Shift` + `F` on Windows ) to find all the references, e.g. "Cat food"
-- `Cmd` + `Shift` + `H` ( `Ctrl` + `Shift` + `F` on Windows ) to replace them with [[cat-food]].
+- `Cmd` + `Shift` + `H` ( `Ctrl` + `Shift` + `H` on Windows ) to replace them with [[cat-food]].
 - Click any of the references to create a new note.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
+[todo]: todo.md "Todo"
+[roadmap]: roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/diagrams-in-markdown.md

@@ -1,18 +0,0 @@
-# Diagrams in Markdown
-
-You can use VS Code plugins such as [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) to draw and preview diagrams in your content.
-
-⚠️ Be aware that Mermaid diagrams don't automatically get rendered in published Foams in [[github-pages]], and would require you to eject to another static site generation approach that supports Mermaid plugins.
-
----
-
-[[todo]] [[good-first-task]] **Help improve this recipe!** 
-
-[[todo]] [[good-first-task]] Suggestions for alternative diagramming approaches welcome
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[github-pages]: github-pages "Github Pages"
-[good-first-task]: good-first-task "Good First Task"
-[todo]: todo "Todo"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[//end]: # "Autogenerated link references"

docs/feature-comparison.md

@@ -1,3 +0,0 @@
-# Feature comparison
-
-- In order to understand what is needed, would be good to have a comparison.

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 [VS Code Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) **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,8 @@ 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 "Wiki Links"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
-[roadmap]: roadmap "Roadmap"
+[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"
 [//end]: # "Autogenerated link references"

docs/features/cli.md

@@ -9,7 +9,5 @@ Create a CLI tool to allow running common Foam commands. These may include:
 More commands to be added.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[workspace-janitor]: workspace-janitor "Workspace Janitor (stub)"
-[//end]: # "Autogenerated link references"
+[workspace-janitor]: workspace-janitor.md "Janitor"
+[//end]: # "Autogenerated link references"

docs/features/creating-new-notes.md

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

@@ -0,0 +1,31 @@
+# Custom Markdown Preview Styles
+
+Visual Studio Code allows you to use your own CSS in the Markdown preview tab.
+
+## Instructions
+
+Custom CSS for the Markdown preview can be implemented by using the `"markdown.styles": []` setting in `settings.json`. The stylesheets can either be https URLs or relative paths to local files in the current workspace.
+
+For example, to load a stylesheet called `Style.css`, we can update `settings.json` with the following line:
+
+```
+{
+  "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/custom-snippets.md

@@ -0,0 +1,10 @@
+# Adding Custom Snippets
+
+You can add custom snippets whilst the default set of snippets are decided by following the below steps:
+
+1. `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type `snippets` and select `Preferences: Configure User Snippets`.
+2. The command palette will remain in focus. Search for `markdown` and select the entry entitled `markdown.json (Markdown)`.
+3. A JSON file will open. You can author your own snippets using the [documentation](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets) to help you, or if you're using a snippet shared by another Foam user then you can copy and paste it in, as the below GIF demonstrates:
+   ![Demonstrating adding a custom snippet](../assets/images/custom-snippet.gif)
+
+To get started, you might consider replacing the entire contents of the `markdown.json` file opened by the steps above with the JSON in [this comment](https://github.com/foambubble/foam/pull/192#issuecomment-666736270).

docs/features/daily-notes.md

@@ -0,0 +1,49 @@
+# Daily notes
+
+Automatically create a Daily Note by executing the "Foam: Open Daily Note" command. If a Daily Note for today's date already exists, the command opens the existing note.
+
+![Daily note feature in action](../assets/images/daily-note.gif)
+
+## Keyboard shortcut
+
+The default keyboard shortcut for "Open Daily Note" is `alt`+`d`. This can be overridden using the [VS Code Keybindings editor](https://code.visualstudio.com/docs/getstarted/keybindings).
+
+## Configuration
+
+By default, Daily Notes will be created in a file called `yyyy-mm-dd.md` in the workspace root, with a heading `yyyy-mm-dd`.
+
+These settings can be overridden in your workspace or global `.vscode/settings.json` file, using the [**dateformat** date masking syntax](https://github.com/felixge/node-dateformat#mask-options):
+
+```jsonc
+  "foam.openDailyNote.directory": "journal", // a relative directory path will get appended to the workspace root. An absolute directory path will be used unmodified.
+  "foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd",
+  "foam.openDailyNote.fileExtension": "mdx",
+  "foam.openDailyNote.titleFormat": "'Journal Entry, ' dddd, mmmm d",
+```
+
+The above configuration would create a file `journal/note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`.
+
+## Daily Note Templates
+
+Daily notes can also make use of [templates](note-templates.md), by defining a special `.foam/templates/daily-note.md` template.
+
+See [Note Templates](note-templates.md) for details of the features available in templates.
+
+## Roam-style Automatic Daily Notes
+
+Foam provides an option for automatically opening your Daily Note when you open your Foam workspace. You can enable it by specifying the following configuration in your `.vscode/settings.json`:
+
+```json
+{
+  // ...Other configurations
+  "foam.openDailyNote.onStartup": true
+}
+```
+
+## Extend Functionality (Weekly, Monthly, Quarterly Notes)
+
+Please see [[note-macros]]
+
+[//begin]: # 'Autogenerated link references for markdown compatibility'
+[note-macros]: ../recipes/note-macros.md 'Custom Note Macros'
+[//end]: # 'Autogenerated link references'

docs/features/foam-logging-in-vscode.md

@@ -0,0 +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/git-integration.md

@@ -0,0 +1,12 @@
+# Git Integration
+
+There are (too) many ways to commit your changes to source control:
+
+- Using VS Code's own git integration
+  - The quick and easy way is to use the `Git: Commit All` command after editing files. The default Foam workspace settings will stage & sync all of your changes to the remote:
+- Using GitDoc for [[automatic-git-syncing]]
+- Whatever way you like to do it (CLI?)
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[automatic-git-syncing]: ../recipes/automatic-git-syncing.md "Automatically Sync with Git"
+[//end]: # "Autogenerated link references"

docs/features/graph-visualisation.md

@@ -0,0 +1,62 @@
+# Graph Visualisation
+
+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`
+- automatically center the graph on the currently edited note, to immediately see it's connections
+
+## Custom Graph Styles
+
+Currently, custom graph styles are supported through the `foam.graph.style` setting.
+
+![Graph style demo](../assets/images/graph-style.gif)
+
+A sample configuration object is provided below:
+
+```json
+"foam.graph.style": {
+    "background": "#202020",
+    "fontSize": 12,
+    "lineColor": "#277da1",
+    "lineWidth": 0.2,
+    "particleWidth": 1.0,
+    "highlightedForeground": "#f9c74f",
+    "node": {
+        "note": "#277da1",
+        "placeholder": "#545454",
+    }
+}
+```
+
+### 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:
+
+```
+---
+type: feature
+---
+# Backlinking
+
+...
+```
+
+And the following `settings.json`:
+
+```json
+"foam.graph.style": {
+    "node": {
+        "feature": "red",
+    }
+}
+```
+
+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/key-bindings.md

@@ -7,5 +7,5 @@
 - [ ]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
+[todo]: ../dev/todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/features/link-reference-definitions.md

@@ -0,0 +1,78 @@
+# Link Reference Definitions
+
+## Introduction
+
+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
+  - [[wikilinks]]
+  - [[github-pages]]
+  ```
+
+...generates the following link reference definitions to the bottom of the file:
+
+  ```md
+  [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 `[[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)
+
+## Configuration
+
+You can choose to generate link reference definitions with or without file extensions, depending on the target, or to disable the generation altogether. As a rule of thumb:
+
+- Links with file extensions work better with standard markdown-based tools, such as GitHub web UI.
+- Links without file extensions work better with certain web publishing tools that treat links as literal urls and don't transform them automatically, such as the standard GitHub pages installation.
+
+By default, Foam generates links without file extensions for legacy reasons, but this may change in future versions.
+
+You can override this setting in your Foam workspace's `settings.json`:
+
+- `"foam.edit.linkReferenceDefinitions": "withoutExtensions"` (default)
+- `"foam.edit.linkReferenceDefinitions": "withExtensions"`
+- `"foam.edit.linkReferenceDefinitions": "off"`
+
+### Ignoring files
+
+Sometimes, you may want to ignore certain files or folders, so that Foam doesn't generate link reference definitions to them.
+
+For instance, if you're using a local instance of [Jekyll](https://jekyllrb.com/), you may find that it writes copies of each `.md` file into a `_site` directory, which may lead to Foam generating references to them instead of the original source notes.
+
+You can ignore the `_site` directory by adding the following to your `.vscode/settings.json`:
+
+```json
+  "files.exclude": {
+    "**/_site": true
+  },
+  "files.watcherExclude": {
+    "**/_site": true
+  },
+```
+
+After changing the setting in your workspace, you can run the [[workspace-janitor]] command to convert all existing definitions.
+
+[[todo]] _Implement a `foam.eclude
+
+## Future improvements
+
+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"
+[link-reference-definition-improvements]: ../dev/link-reference-definition-improvements.md "Link Reference Definition Improvements"
+[//end]: # "Autogenerated link references"

docs/features/note-templates.md

@@ -0,0 +1,188 @@
+# 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 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:
+
+* 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_
+
+## 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_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_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. See [#693](https://github.com/foambubble/foam/issues/693).
+
+### `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/orphans.md

@@ -0,0 +1,10 @@
+# Orphans
+
+Foam helps you to find orphans: notes that have neither forward links nor backlinks.
+
+Orphans can be found in the Orphans panel.
+
+Two settings allows you to control the behaviour of the Orphans panel:
+
+- `foam.orphans.exclude`: list of glob patterns that will be used to exclude directories. For example, a value of `["journal/**/*"]` would exclude your daily notes.
+- `foam.orphans.groupBy`: sets the default view mode of the Orphans panel: either groups by folder (by default), or lists all orphans. The view can be toggled on the fly from the panel, but it won't overwrite the setting.

docs/features/tags.md

@@ -0,0 +1,25 @@
+# Tags
+
+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.
+For example you can tag your notes about books with [[book]].

docs/features/workspace-janitor.md

@@ -0,0 +1,42 @@
+# Janitor
+
+To store your personal knowledge graph in markdown files instead of a database, we need some additional tooling to create and maintain relationships with notes.
+
+**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.
+
+## Using Janitor from VS Code (Experimental)
+
+Execute the "Foam: Run Janitor" command from the command palette.
+
+![Foam Janitor demo](../assets/images/foam-janitor-demo.gif)
+
+## Using Janitor from command line (Experimental)
+
+> ⚠️ Improvements to this documentation are welcome!
+
+The Janitor can be installed from [NPM](https://www.npmjs.com/) and executed as a standalone CLI tool:
+
+```sh
+> npm install -g foam-cli
+> foam janitor path/to/workspace
+```
+
+You can run the Janitor as a git hook on every commit to ensure your workspace links are up to date. This can be especially helpful if you edit your markdown documents from other apps.
+
+You can also run the Janitor from a GitHub action to ensure that all changes coming to your workspace are up to date. This can be useful when editing your Foam notes from mobile (i.e. via [GitJournal](https://gitjournal.io)), or your Foam has multiple contributors and you want to ensure that all changes are correctly integrated.
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[materialized-backlinks]: ../dev/materialized-backlinks.md "Materialized Backlinks (stub)"
+[//end]: # "Autogenerated link references"

docs/foam-file-format.md

@@ -1,42 +0,0 @@
-# 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]]`.
-
-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]]`:
-
-- **It needs to have a single top level `# Heading`.**
-  - This will be used as document title.
-    - [[decision-needed]] Do we need it?
-    - [[decision-needed]] How much to deviate from just markdown
-- **File name should not contain spaces,** e.g. `foam-file-format.md` is a valid name, but `Foam File Format.md` is not.
-  - This is a temporary limitation and will be lifted in future versions.
-  - Technically this actually works already, but may have some edge cases you don't want to deal with if you can avoid it.
-- **File name should have extension `.md` or `.markdown`**
-  - 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.**
-  - When you do, 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.
-    - Here's an example:
-      - [[wiki-links]]
-      - [[github-pages]]
-    - This will generate the following references:
-      ```md
-      [wiki-links]: wiki-links "Wiki Links"
-      [github-pages]: github-pages "Github Pages"
-      ```
-    - The three components 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 destination** The target of the matched link
-        - Right now we generate link destinations without file extension. This is a choice, see [discussion here](https://foambubble.github.io/foam/wiki-links#why-dont-wiki-links-work-on-github).
-      - **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime)
-    - Open the [raw markdown](https://raw.githubusercontent.com/foambubble/foam/master/foam-file-format.md) to see them at the bottom of this file
-    - In the near future, these can be batch generated for all workspace files (WIP)
-      - For the time being, if you want to get [[wiki-links]] support across all files, you'll need to generate the link reference definitions yourself.
-      - If you end up writing a batch job for this, please share your solution, as this is something we'll need to implement soon!
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links "Wiki Links"
-[github-pages]: github-pages "Github Pages"
-[decision-needed]: decision-needed "Decision Needed"
-[daily-notes]: daily-notes "Daily notes"
-[//end]: # "Autogenerated link references"

docs/foam-linter.md

@@ -1,11 +0,0 @@
-# Foam Linter (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/frequently-asked-questions.md

@@ -0,0 +1,22 @@
+# Frequently Asked Questions
+
+> ⚠️ Foam is still in preview. Expect the experience to be a little rough.
+
+- [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]], [[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"
+[wikilinks]: wikilinks.md "Wikilinks"
+[//end]: # "Autogenerated link references"

docs/git-flows-for-teams.md

@@ -1,10 +0,0 @@
-# Git Flows for Teams (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/git-integration.md

@@ -1,18 +0,0 @@
-# Git integration
-
-There are (too) many ways to commit your changes to source control:
-
-- Using VS Code's own git integration
-- Using GitLens (included in Foam for inline blame)
-- Whatever way you like to do it (CLI?)
-
-The quick and easy way is to use the Git: Commit All command after editing files. The default Foam workspace settings will stage & sync all of your changes to the remote:
-
-- `Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), execute `Git: Commit All`
-
-This could be improved. [[todo]] [[good-first-task]]
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[good-first-task]: good-first-task "Good First Task"
-[//end]: # "Autogenerated link references"

docs/github-pages.md

@@ -1,12 +0,0 @@
-# Github Pages
-
-- The [Foam template](https://github.com/foambubble/foam-template) is **GitHub Pages** ready, all you have to do is [turn it 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.
-
-[[todo]] [[good-first-task]] Improve this documentation
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[good-first-task]: good-first-task "Good First Task"
-[//end]: # "Autogenerated link references"

docs/graph-in-published-workspace.md

@@ -1,10 +0,0 @@
-# Graph in Published Workspace (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/graph-visualisation.md

@@ -1,12 +0,0 @@
-# Graph visualisation
-
-`Cmd` + `Shift` + `P` (`Ctrl` + `Shift` + `P` for Windows), type `Show graph`.
-
-(Depends on [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links).)
-
-![Demo of graph visualiser](assets/images/foam-navigation-demo.gif)
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links "Wiki Links"
-[todo]: todo "Todo"
-[//end]: # "Autogenerated link references"

docs/improve-default-workspace-settings.md

@@ -1,10 +0,0 @@
-# Improve Default Workspace Settings (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/improved-backlinking.md

@@ -1,11 +0,0 @@
-# Improved Backlinking (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-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]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"

docs/improved-static-site-generation.md

@@ -1,15 +0,0 @@
-# Improved Static Site Generation (stub)
-
-**[[todo]] This [[roadmap]] item needs more specification work.** 
-
-If you're interested in working on it, please start a conversation in [GitHub issues](https://github.com/foambubble/foam/issues).
-
-## Notes
-
-- We should consider moving to gatsby, similar to [Foam Gatsby Template](https://mathieudutour.github.io/foam-gatsby-template/)
-
-
-[//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
-[roadmap]: roadmap "Roadmap"
-[//end]: # "Autogenerated link references"