v0.7.2

Added API and events around note deletion

Improved github workflows, added logic to avoid duplicate runs in CI and merged build + test jobs

Added support for running workflows in multiple environments, commented window-2019 as test don't pass, but they will be fixed in another PR to avoid scope creep here.

.all-contributorsrc

@@ -175,7 +175,8 @@
       "profile": "https://anku.netlify.com/",
       "contributions": [
         "doc",
-        "test"
+        "test",
+        "code"
       ]
     },
     {
@@ -211,7 +212,8 @@
       "avatar_url": "https://avatars3.githubusercontent.com/u/8980971?v=4",
       "profile": "https://sanketdg.github.io",
       "contributions": [
-        "doc"
+        "doc",
+        "code"
       ]
     },
     {
@@ -342,6 +344,188 @@
       "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"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/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!

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Create a report to help us be foamier
+labels: bug
+---
+
+<!-- Check in the VSCode extension tab. -->
+- Foam version:
+
+**Summary**
+<!-- A clear and concise description of what the bug is.-->
+
+**Steps to reproduce**
+1.
+2.
+
+Does this issue occur on the [foam template](https://github.com/foambubble/foam-template) repo? Yes/No
+
+**Additional information**
+<!-- Add any other context about the problem here. -->
+*Feel free to attach a screenshot and/or include a zip with a minimal repo to reproduce the issue*

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Question
+    url: https://discord.gg/8c4BChMfSu
+    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,48 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+  # The following will also make the workflow run on all PRs, internal and external.
+  # This would create duplicate runs, that we are skipping by adding the "if" to the jobs below.
+  # See https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-18.04
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - 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] # add windows-2019 after fixing tests for it
+    runs-on: ${{ matrix.os }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
+    env:
+      OS: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12'
+      - name: Install Dependencies
+        run: yarn
+      - name: Build Packages
+        run: yarn build
+      - name: Run Tests
+        run: yarn test

.github/workflows/foam-cli.yml

@@ -1,25 +0,0 @@
-name: Test foam-cli
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-cli/**'
-  push:
-    paths:
-      - 'packages/foam-cli/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-
-      - name: Install dependencies
-        run: yarn
-
-      # - name: Lint foam-lint
-      #   run: yarn workspace foam-cli lint
-
-      - name: Test foam-cli
-        run: yarn workspace foam-cli test

.github/workflows/foam-core.yml

@@ -1,25 +0,0 @@
-name: Test foam-core
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-core/**'
-  push:
-    paths:
-      - 'packages/foam-core/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-
-      - name: Install dependencies
-        run: yarn
-
-      - name: Lint foam-core
-        run: yarn workspace foam-core lint
-
-      - name: Test foam-core
-        run: yarn workspace foam-core test

.github/workflows/foam-vscode.yml

@@ -1,29 +0,0 @@
-name: Test foam-vscode
-
-on:
-  pull_request:
-    paths:
-      - 'packages/foam-vscode/**'
-  push:
-    paths:
-      - 'packages/foam-vscode/**'
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-
-      - name: Install dependencies
-        run: yarn
-
-      - name: Lint foam-vscode
-        run: yarn workspace foam-vscode lint
-      - name: Test foam-vscode
-        run: yarn workspace foam-vscode test
-      # - name: Publish foam-vscode
-      #   if: github.ref == 'refs/heads/master'
-      #   run: yarn workspace foam-vscode publish-extension
-      #   with:
-      #     vsce_token: ${{ secrets.VSCE_TOKEN }}

.vscode/settings.json

@@ -7,9 +7,15 @@
     },
     "search.exclude": {
         // set this to false to include compiled JS folders in search results
-        "packages/**/out": true, 
+        "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"
+    "typescript.tsc.autoDetect": "off",
+    "foam.files.ignore": [
+        "**/.vscode/**/*",
+        "**/_layouts/**/*",
+        "**/_site/**/*",
+        "**/node_modules/**/*"
+    ]
 }

docs/.vscode/settings.json

@@ -5,6 +5,7 @@
   "editor.overviewRulerBorder": false,
   "editor.lineHeight": 24,
   "workbench.colorTheme": "Gray Matter Light",
+  "foam.edit.linkReferenceDefinitions": "withExtensions",
   "vscodeMarkdownNotes.noteCompletionConvention": "noExtension",
   "[markdown]": {
     "editor.quickSuggestions": {

docs/_layouts/foam.html

@@ -19,10 +19,27 @@ window.addEventListener('DOMContentLoaded', (event) => {
   document
     .querySelectorAll(".markdown-body a[title]:not([href^=http])")
     .forEach((a) => {
-      // Hack: Replace page-link with "Page Title"...
-      a.innerText = a.title;
-      // ...and normalize the links to allow html pages navigation
-      a.href = normalizeMdLink(a.href);
+      // filter to only wiki-links
+      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) => {

docs/architecture.md

@@ -0,0 +1,21 @@
+---
+tags: architecture
+---
+# Architecture
+
+This document aims to provide a quick overview of the Foam architecture!
+
+Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
+- [/docs](https://github.com/foambubble/foam/docs): documentation and [[recipes]].
+- [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core) - Powers the core functionality in Foam across all platforms.
+- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) - The core VSCode plugin.
+- [/packages/foam-cli](https://github.com/foambubble/foam/tree/master/packages/foam-cli) - The Foam CLI tool.
+
+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.
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[recipes]: recipes.md "Recipes"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[//end]: # "Autogenerated link references"

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 +1,11 @@
 # Automatic Git Syncing (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/azure-devops-wiki.md

@@ -8,7 +8,7 @@ The following recipe is written with the assumption that you already have an [Az
 
 ## Setup a Foam workspace
 
-1. Generate a Foam workspace using the [foam-template project](https://github.com/foambubble/foam-template). 
+1. Generate a Foam workspace using the [foam-template project](https://github.com/foambubble/foam-template).
 2. Change the remote to a git repository in Azure DevOps (Repos -> Import a Repository -> Add Clone URL with Authentication), or copy all the files into a new Azure DevOps git repository.
 3. Define which document will be the wiki home page. To do that, create a file called `.order` in the Foam workspace root folder, with first line being the document filename without `.md` extension. For a project created from the Foam template, the file would look like this:
 ```
@@ -20,21 +20,21 @@ readme
 
 
 1. Navigate to your Azure DevOps project in a web browser.
-2. Choose **Overview** > **Wiki**. If you don't have wikis for your project, choose **Publish code as a wiki** on welcome page. 
+2. Choose **Overview** > **Wiki**. If you don't have wikis for your project, choose **Publish code as a wiki** on welcome page.
 3. Choose repository with your Foam workspace, branch (usually `master` or `main`), folder (for workspace created from foam-template it is `/`), and wiki name, and press **Publish**.
 
 A published workspace looks like this:
 
 ![Azure DevOps wiki](assets/images/azure-devops-wiki-demo.png)
 
-There is default table of contents pane to the left of the wiki content. Here, you'll find a list of all directories that are present in your Foam workspace, and all wiki pages. Page names are derived from files names, and they are listed in alphabetical order. You may reorder pages by adding filenames without `.md` extension to `.order` file. 
+There is default table of contents pane to the left of the wiki content. Here, you'll find a list of all directories that are present in your Foam workspace, and all wiki pages. Page names are derived from files names, and they are listed in alphabetical order. You may reorder pages by adding filenames without `.md` extension to `.order` file.
 
 _Note that first entry in `.order` file defines wiki's home page._
 
 ## Update wiki
 
 While you are pushing changes to GitHub, you won't see the wiki updated if you don't add Azure as a remote. You can push to multiple repositories simultaneously.
- 
+
  1. First open a terminal and check if Azure is added running: `git remote show origin`. If you don't see Azure add it in the output then follow these steps.
  2. Rename your current remote (most likely named origin) to a different name by running: `git remote rename origin main`
  3. You can then add the remote for your second remote repository, in this case, Azure. e.g `git remote add azure https://<YOUR_ID>@dev.azure.com/<YOUR_ID>/foam-notes/_git/foam-notes`. You can get it from: Repos->Files->Clone and copy the URL.
@@ -42,9 +42,9 @@ While you are pushing changes to GitHub, you won't see the wiki updated if you d
  5. Add the `remote origin` section to the bottom of the file with the URLs from each remote repository you'd like to push to. You'll see something like that:
  ```bash
  [core]
-  ... 
+  ...
    (ignore this part)
-   ... 
+   ...
 [branch "master"]
   remote = github
   merge = refs/heads/master
@@ -59,5 +59,5 @@ While you are pushing changes to GitHub, you won't see the wiki updated if you d
   url = https://<YOUR_ID>@dev.azure.com/<YOUR_ID>/foam-notes/_git/foam-notes
  ```
  6. You can then push to both repositories by: `git push origin master` or a single one using: `git push github master` or `git push azure master`
-  
-For more information, read the [Azure DevOps documentation](https://docs.microsoft.com/en-us/azure/devops/project/wiki/publish-repo-to-wiki). 
+
+For more information, read the [Azure DevOps documentation](https://docs.microsoft.com/en-us/azure/devops/project/wiki/publish-repo-to-wiki).

docs/backlinking.md

@@ -8,8 +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"
-[make-backlinks-more-prominent]: make-backlinks-more-prominent "Make Backlinks More Prominent"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
-[roadmap]: roadmap "Roadmap"
+[wiki-links]: wiki-links.md "Wiki Links"
+[make-backlinks-more-prominent]: make-backlinks-more-prominent.md "Make Backlinks More Prominent"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[roadmap]: roadmap.md "Roadmap"
 [//end]: # "Autogenerated link references"

docs/big-vision.md

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

docs/block-references.md

@@ -1,10 +1,10 @@
 # Block 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).
 
 [//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/blog.md

@@ -3,5 +3,5 @@
 - [[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"
+[2020-07-11-three-weeks-in]: blog/2020-07-11-three-weeks-in.md "Three Weeks In"
 [//end]: # "Autogenerated link references"

docs/build-vs-assemble.md

@@ -12,5 +12,5 @@ Overall, we should strive to build big things from small things. Focused, intero
 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"
+[referencing-notes-by-title]: referencing-notes-by-title.md "Referencing notes by title"
 [//end]: # "Autogenerated link references"

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

@@ -70,7 +70,7 @@ const base = 'https://api.github.com';
 
 
 const posttime = new Date();
-const title = draft.title;  
+const title = draft.title;
 const txt = draft.processTemplate("[[line|3..]]");
 const mergedTags = [...draft.tags, ...requiredTags];
 const slugbase = title.toLowerCase().replace(/\s/g, "-");

docs/cli.md

@@ -9,5 +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"
-[workspace-janitor]: workspace-janitor "Janitor"
-[//end]: # "Autogenerated link references"
+[workspace-janitor]: workspace-janitor.md "Janitor"
+[//end]: # "Autogenerated link references"

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,28 @@
+---
+tags: todo, good-first-task
+---
 # Contribution Guide
+Foam is open to contributions of any kind, including but not limited to code, documentation, ideas, and feedback.
+This guide aims to help guide new and seasoned contributors getting around the Foam codebase.
 
-> [[todo]] [[good-first-task]] This contribution guide itself could be improved 😅
+## Getting Up To Speed
+Before you start contributing we recommend that you read the following links:
 
-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:
+- [[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!
 
-- 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 with 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.
+## Diving In
+We understand that diving in an unfamiliar codebase may seem scary,
+to make it easier for new contributors we provide some resources:
+- [[roadmap]] - You can read our roadmap to see what is coming to Foam, many of these are open to suggestions!
+- [[architecture]] - This document describes the architecture of Foam and how the repository is structured.
 
-## Contributing to the VS Code Extension
+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://discord.gg/rtdZKgj)!
 
-If you're interested in contributing to the VS Code extension (aka `foam-vscode`), this guide will help you get things set up locally.
+## 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 +32,36 @@ 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. 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:
 
-   `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!
+
+### The VS Code Extension
+
+This guide assumes you read the previous instructions and you're set up to work on Foam.
+
+1. Now we'll use the launch configuration defined at [`.vscode/launch.json`](https://github.com/foambubble/foam/blob/master/.vscode/launch.json) to start a new extension host of VS Code. From the root, or the `foam-vscode` workspace, press f5.
+
+2. In the new extension host of VS Code that launched, open a Foam workspace (e.g. your personal one, or a test-specific one created from [foam-template](https://github.com/foambubble/foam-template)). This is strictly not necessary, but the extension won't auto-run unless it's in a workspace with a `.vscode/foam.json` file.
+
+3. Test a command to make sure it's working as expected. Open the Command Palette (Ctrl/Cmd + Shift + P) and select "Foam: Update Markdown Reference List". If you see no errors, it's good to go!
 
 For more resources related to the VS Code Extension, check out the links below:
 
 - [[tutorial-adding-a-new-command-to-the-vs-code-extension]]
 
+---
+
+Feel free to modify and submit a PR if this guide is out-of-date or contains errors!
+
+---
+
 [//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"
+[roadmap]: roadmap.md "Roadmap"
+[architecture]: architecture.md "Architecture"
+[tutorial-adding-a-new-command-to-the-vs-code-extension]: tutorial-adding-a-new-command-to-the-vs-code-extension.md "Tutorial: Adding a New Command to the VS Code Extension"
 [//end]: # "Autogenerated link references"

docs/creating-new-notes.md

@@ -7,6 +7,6 @@
 - 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"
+[search-for-notes]: search-for-notes.md "Search for Notes"
+[graph-visualisation]: graph-visualisation.md "Graph visualisation"
 [//end]: # "Autogenerated link references"

docs/customising-styles.md

@@ -5,6 +5,6 @@ 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"
+[todo]: todo.md "Todo"
+[good-first-task]: good-first-task.md "Good First Task"
 [//end]: # "Autogenerated link references"

docs/daily-notes.md

@@ -10,7 +10,7 @@ The default keyboard shortcut for "Open Daily Note" is `alt`+`d`. This can be ov
 
 ## 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`. 
+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):
 
@@ -33,7 +33,7 @@ In the meantime, you can use [VS Code Snippets](https://code.visualstudio.com/do
 
 In the future, Foam may provide an option for automatically opening your Daily Note when you open your Foam workspace.
 
-If you want this behaviour now, you can use the excellent [Auto Run Command](https://marketplace.visualstudio.com/items?itemName=gabrielgrinberg.auto-run-command#review-details) extension to run the "Open Daily Note" command upon entering a Foam workspace by specifying the following configuration in your `.vscode/settings.json`:
+If you want this behavior now, you can use the excellent [Auto Run Command](https://marketplace.visualstudio.com/items?itemName=gabrielgrinberg.auto-run-command#review-details) extension to run the "Open Daily Note" command upon entering a Foam workspace by specifying the following configuration in your `.vscode/settings.json`:
 
 ```json
   "auto-run-command.rules": [
@@ -44,3 +44,11 @@ If you want this behaviour now, you can use the excellent [Auto Run Command](htt
     }
   ],
 ```
+
+## Extend Functionality (Weekly, Monthly, Quarterly Notes)
+
+Please see [[note-macros]]
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[note-macros]: note-macros.md "Custom Note Macros"
+[//end]: # "Autogenerated link references"

docs/diagrams-in-markdown.md

@@ -1,17 +1,33 @@
 # 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.
+We have two alternative recipes for displaying diagrams in markdown:
+
+- [Diagrams in Markdown](#diagrams-in-markdown)
+  - [Mermaid](#mermaid)
+  - [Draw.io](#drawio)
+    - [Using Draw.io](#using-drawio)
+
+
+## Mermaid
+
+You can use [Mermaid](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) plugin to draw and preview diagrams in your content.
 
 ⚠️ Be aware that Mermaid diagrams don't automatically get rendered in published Foams in [[github-pages]], and would require you to eject to another static site generation approach that supports Mermaid plugins.
 
----
+## Draw.io
 
-[[todo]] [[good-first-task]] **Help improve this recipe!** 
+[Draw.io](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) extension allows you to create, edit, and display your diagrams without leaving Visual Studio Code. The `.drawio.svg` or `.drawio.png` files can be automatically embedded and displayed in published Foams, no export needed. FYI, the diagram below was made using Draw.io! You can check the diagram [here](./assets/images/diagram-drawio-demo.drawio.svg).
+
+![diagram-drawio-demo](./assets/images/diagram-drawio-demo.drawio.svg)
+
+### Using Draw.io
+
+1. Install [Draw.io](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) VS Code extension.
+2. Create a new `*.drawio.svg` or `*.drawio.png` file.
+3. Start drawing your diagram. Once you done, save it.
+4. Embed the diagram file as you embedding the image file, for example: `![My Diagram](my-diagram.drawio.svg)`
 
-[[todo]] [[good-first-task]] Suggestions for alternative diagramming approaches welcome
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[github-pages]: github-pages "Github Pages"
-[todo]: todo "Todo"
-[good-first-task]: good-first-task "Good First Task"
-[//end]: # "Autogenerated link references"
+[github-pages]: github-pages.md "Github Pages"
+[//end]: # "Autogenerated link references"

docs/eleventy-and-netlify.md

@@ -1,9 +1,9 @@
 # Eleventy and Netlify
 
-You can use [foam-eleventy-template](https://github.com/juanfrank77/foam-eleventy-template) to generate a static site with [Eleventy](https://www.11ty.dev/), and host it online on [Netlify](https://www.netlify.com/). 
+You can use [foam-eleventy-template](https://github.com/juanfrank77/foam-eleventy-template) to generate a static site with [Eleventy](https://www.11ty.dev/), and host it online on [Netlify](https://www.netlify.com/).
 
 With this template you can
-- Have control over what to publish and what to keep private 
+- Have control over what to publish and what to keep private
 - Customize the styling of the site to your own liking
 
 ## Publishing your foam

docs/foam-core.md

@@ -96,13 +96,13 @@ 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 "Janitor"
-[cli]: cli "Command Line Interface"
-[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
-[wiki-links]: wiki-links "Wiki Links"
-[link-reference-definitions]: link-reference-definitions "Link Reference Definitions"
-[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]: workspace-janitor.md "Janitor"
+[cli]: cli.md "Command Line Interface"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
+[wiki-links]: wiki-links.md "Wiki Links"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[todo]: todo.md "Todo"
+[feature-comparison]: feature-comparison.md "Feature comparison"
+[foam-core-2020-07-11]: meeting-notes/foam-core-2020-07-11.md "Foam Core 2020-07-11"
 [//end]: # "Autogenerated link references"

docs/foam-file-format.md

@@ -17,6 +17,6 @@ Here are a few specific constraints, mainly because our tooling is a bit fragmen
 - **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.** See [[wiki-links]] for more details.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[decision-needed]: decision-needed "Decision Needed"
-[wiki-links]: wiki-links "Wiki Links"
+[decision-needed]: decision-needed.md "Decision Needed"
+[wiki-links]: wiki-links.md "Wiki Links"
 [//end]: # "Autogenerated link references"

docs/foam-gatsby-template.md

@@ -0,0 +1,25 @@
+# Foam Gatsby Template
+
+You can use [foam-gatsby-template](https://github.com/mathieudutour/foam-gatsby-template) to generate a static site to host it online on Github or [Vercel](https://vercel.com). 
+
+## Publishing your foam to Github pages
+It comes configured with Github actions to auto deploy to Github pages when changes are pushed to your main branch.
+
+## Publishing your foam to Vercel
+
+When you're ready to publish, run a local build.
+```bash
+cd _layouts
+npm run build
+```
+
+Remove `public` from your .gitignore file then commit and push your public folder in `_layouts` to Github.
+
+Log into your Vercel account. (Create one if you don't have it already.)
+
+Import your project. Select `_layouts/public` as your root directory and click **Continue**. Then name your project and click **Deploy**.
+
+That's it! 
+
+
+

docs/foam-linter.md

@@ -1,11 +1,11 @@
 # Foam Linter (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/foam-local-plugins.md

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

docs/frequently-asked-questions.md

@@ -12,8 +12,8 @@
 - Check the formatting rules for links on [[foam-file-format]], [[wiki-links]] and [[link-formatting-and-autocompletion]]
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[foam-file-format]: foam-file-format "Foam File Format"
-[wiki-links]: wiki-links "Wiki Links"
-[link-formatting-and-autocompletion]: link-formatting-and-autocompletion "Link Formatting and Autocompletion"
-[//end]: # "Autogenerated link references"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[foam-file-format]: foam-file-format.md "Foam File Format"
+[wiki-links]: wiki-links.md "Wiki Links"
+[link-formatting-and-autocompletion]: link-formatting-and-autocompletion.md "Link Formatting and Autocompletion"
+[//end]: # "Autogenerated link references"

docs/gistpad.md

@@ -10,9 +10,9 @@ To start using GistPad for your Foam-based knowledge base, simply perform the fo
 
 1. Download the [GistPad extension](https://aka.ms/gistpad) and then re-start Visual Studio Code
 
-1. Run the `GistPad: Sign In` command, and provide a [GitHub token](https://github.com/settings/tokens/new) that includes the `repo` scope (and optionally `gist` and `delete_repo` scope, if you'd like to use GistPad for managing your GitHub content more holistically)
+1. Run the `GistPad: Sign In` command and then complete the authentication flow using your GitHub account
 
-1. Run the `GistPad: Manage Repository` command and select the `Create repo from template...` or `Create private repo from template...` depending on your preference
+1. Run the `GistPad: Open Repository` command and select the `Create repo from template...` or `Create private repo from template...` depending on your preference
 
 1. Select the `Foam-style wiki` template, and then specify a name for your Foam workspace (e.g. `my-foam-notes`, `johns-knowledge-base`)
 
@@ -46,6 +46,6 @@ You can view a page's backlinks using either of the following techniques:
 
 ## Daily Pages
 
-In addition to create arbitrary pages, you can also use GistPad for journaling or capturing [daily notes](https://github.com/vsls-contrib/gistpad#daily-pages). Simply click the calendar icon in the `Repositories` tree, which will open up the page that represents today. If the page doesn't already exist, then it will be created in the workspace before being opened.
+In addition to creating arbitrary pages, you can use GistPad for journaling or capturing [daily notes](https://github.com/vsls-contrib/gistpad#daily-pages). Simply click the calendar icon in the `Repositories` tree, which will open up the page that represents today. If the page doesn't already exist, then it will be created in the workspace before being opened.
 
 <img width="700px" src="https://user-images.githubusercontent.com/116461/87234721-b356cc00-c388-11ea-946a-e7f9c92258a6.png" />

docs/git-flows-for-teams.md

@@ -1,10 +1,10 @@
 # Git Flows for Teams (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/git-integration.md

@@ -13,6 +13,6 @@ The quick and easy way is to use the Git: Commit All command after editing files
 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"
+[todo]: todo.md "Todo"
+[good-first-task]: good-first-task.md "Good First Task"
 [//end]: # "Autogenerated link references"

docs/github-pages.md

@@ -4,9 +4,22 @@
 - 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.
 
+## Other templates
+There are many other templates which also support publish your foam workspace to github pages
+
+* gatsby-digital-garden
+    * [repo](https://github.com/mathieudutour/gatsby-digital-garden)
+    * [demo-website](https://mathieudutour.github.io/gatsby-digital-garden/)
+* foam-mkdocs-template
+    * [repo](https://github.com/Jackiexiao/foam-mkdocs-template)
+    * [demo-website](https://jackiexiao.github.io/foam/)
+* foam-jekyll-template
+    * [repo](https://github.com/hikerpig/foam-jekyll-template)
+    * [demo-website](https://wiki.hikerpig.cn/)
+
 [[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"
+[todo]: todo.md "Todo"
+[good-first-task]: good-first-task.md "Good First Task"
 [//end]: # "Autogenerated link references"

docs/gitlab-pages.md

@@ -11,13 +11,23 @@ Generate a solution using the [Foam template].
 Change the remote to GitLab, or copy all the files into a new GitLab repo.
 
 ### Add a _config.yaml
-Add another file to the root directory (the one with `readme.md` in it) called `_config.yaml` (no extension) 
+Add another file to the root directory (the one with `readme.md` in it) called `_config.yaml` (no extension)
 
 ```yaml
 title: My Awesome Foam Project
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "/" # the base hostname & protocol for your site
 theme: jekyll-theme-minimal
+plugins:
+  - jekyll-optional-front-matter
+optional_front_matter:
+  remove_originals: true
+defaults:
+  -
+    scope:
+      path: "" # we need to add this to properly render layouts
+    values:
+      layout: "default"
 ```
 
 You can choose a theme if you want from places like [Jekyll Themes](https://jekyllthemes.io/)
@@ -32,7 +42,7 @@ source "https://rubygems.org"
 gem "jekyll"
 gem "jekyll-theme-minimal"
 gem "jekyll-optional-front-matter"
-``` 
+```
 
 Commit the file and push it to gitlab.
 

docs/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 (stub)"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

docs/graph-in-published-workspace.md

@@ -1,10 +1,10 @@
 # Graph in Published Workspace (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/how-to-write-recipes.md

@@ -15,7 +15,7 @@ Recipes are intended to document:
 
 The first section should be a bulleted list of extensions required to use this recipe. At a minimum, this section should list all additional, non-standard extensions.
 
-Ideally, you should also note which Foam [[recommended-extensions]] are responsible for providing this feature, so any issue reports can be directed to the correct repositories. 
+Ideally, you should also note which Foam [[recommended-extensions]] are responsible for providing this feature, so any issue reports can be directed to the correct repositories.
 
 When creating new recipes, if you don't know which extension does what, you can leave it out.
 
@@ -33,10 +33,10 @@ That's pretty much it!
 
 You can add [[recipes]] by creating a pull request to [foambubble/foam](https://github.com/foambubble/foam) on GitHub.
 
-Read more in our [[contribution-guide]]. 
+Read more in our [[contribution-guide]].
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[recipes]: recipes "Recipes"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[//end]: # "Autogenerated link references"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[recipes]: recipes.md "Recipes"
+[contribution-guide]: contribution-guide.md "Contribution Guide"
+[//end]: # "Autogenerated link references"

docs/improve-default-workspace-settings.md

@@ -1,10 +1,10 @@
 # Improve Default Workspace Settings (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/improved-backlinking.md

@@ -1,11 +1,11 @@
 # Improved Backlinking (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/improved-static-site-generation.md

@@ -1,6 +1,6 @@
 # Improved Static Site Generation (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
 
 
 [//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/inbox.md

@@ -16,7 +16,7 @@ Uncategorised thoughts, to be added
   - Every Foam could have a different theme even in the editor, so you'll see it like they see it
     - UI and layout design of your workspace can become a thing
 - Developer documentation
-  - GistPad has a good vs code contrib primer: https://github.com/jevakallio/gistpad/blob/master/CONTRIBUTING.md  
+  - GistPad has a good vs code contrib primer: https://github.com/jevakallio/gistpad/blob/master/CONTRIBUTING.md
 - VS Code Notebooks API
   - https://code.visualstudio.com/api/extension-guides/notebook
 - Snippets in template

docs/index.md

@@ -11,7 +11,7 @@ You can use **Foam** for organising your research, keeping re-discoverable notes
 </p>
 
 <div class="website-only">
-    <a class="github-button" href="https://github.com/foambubble/foam" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star foambubble/foam on GitHub">Star</a> 
+    <a class="github-button" href="https://github.com/foambubble/foam" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star foambubble/foam on GitHub">Star</a>
     <a class="github-button" href="https://github.com/foambubble/foam-template" data-icon="octicon-repo-template" data-size="large" aria-label="Use this template foambubble/foam-template on GitHub">Use this template</a>
 </div>
 
@@ -131,13 +131,13 @@ If that sounds like something you're interested in, I'd love to have you along o
     <td align="center"><a href="https://styfle.dev/"><img src="https://avatars1.githubusercontent.com/u/229881?v=4" width="60px;" alt=""/><br /><sub><b>Steven</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=styfle" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/Georift"><img src="https://avatars2.githubusercontent.com/u/859430?v=4" width="60px;" alt=""/><br /><sub><b>Tim</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Georift" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/sauravkhdoolia"><img src="https://avatars1.githubusercontent.com/u/34188267?v=4" width="60px;" alt=""/><br /><sub><b>Saurav Khdoolia</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=sauravkhdoolia" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://anku.netlify.com/"><img src="https://avatars1.githubusercontent.com/u/22813027?v=4" width="60px;" alt=""/><br /><sub><b>Ankit Tiwari</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=anku255" title="Documentation">📖</a> <a href="https://github.com/foambubble/foam/commits?author=anku255" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://anku.netlify.com/"><img src="https://avatars1.githubusercontent.com/u/22813027?v=4" width="60px;" alt=""/><br /><sub><b>Ankit Tiwari</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=anku255" title="Documentation">📖</a> <a href="https://github.com/foambubble/foam/commits?author=anku255" title="Tests">⚠️</a> <a href="https://github.com/foambubble/foam/commits?author=anku255" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/ayushbaweja"><img src="https://avatars1.githubusercontent.com/u/44344063?v=4" width="60px;" alt=""/><br /><sub><b>Ayush Baweja</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ayushbaweja" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/TaiChi-IO"><img src="https://avatars3.githubusercontent.com/u/65092992?v=4" width="60px;" alt=""/><br /><sub><b>TaiChi-IO</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=TaiChi-IO" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/juanfrank77"><img src="https://avatars1.githubusercontent.com/u/12146882?v=4" width="60px;" alt=""/><br /><sub><b>Juan F Gonzalez </b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=juanfrank77" title="Documentation">📖</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://sanketdg.github.io"><img src="https://avatars3.githubusercontent.com/u/8980971?v=4" width="60px;" alt=""/><br /><sub><b>Sanket Dasgupta</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SanketDG" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://sanketdg.github.io"><img src="https://avatars3.githubusercontent.com/u/8980971?v=4" width="60px;" alt=""/><br /><sub><b>Sanket Dasgupta</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SanketDG" title="Documentation">📖</a> <a href="https://github.com/foambubble/foam/commits?author=SanketDG" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/nstafie"><img src="https://avatars1.githubusercontent.com/u/10801854?v=4" width="60px;" alt=""/><br /><sub><b>Nicholas Stafie</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=nstafie" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/francishamel"><img src="https://avatars3.githubusercontent.com/u/36383308?v=4" width="60px;" alt=""/><br /><sub><b>Francis Hamel</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=francishamel" title="Code">💻</a></td>
     <td align="center"><a href="http://digiguru.co.uk"><img src="https://avatars1.githubusercontent.com/u/619436?v=4" width="60px;" alt=""/><br /><sub><b>digiguru</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=digiguru" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=digiguru" title="Documentation">📖</a></td>
@@ -156,6 +156,30 @@ If that sounds like something you're interested in, I'd love to have you along o
   </tr>
   <tr>
     <td align="center"><a href="https://github.com/hooncp"><img src="https://avatars1.githubusercontent.com/u/48883554?v=4" width="60px;" alt=""/><br /><sub><b>hooncp</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=hooncp" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://rt-canada.ca"><img src="https://avatars1.githubusercontent.com/u/13721239?v=4" width="60px;" alt=""/><br /><sub><b>Martin Laws</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=martinlaws" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://seanksmith.me"><img src="https://avatars3.githubusercontent.com/u/2085441?v=4" width="60px;" alt=""/><br /><sub><b>Sean K Smith</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=sksmith" title="Code">💻</a></td>
+    <td align="center"><a href="https://www.linkedin.com/in/kevin-neely/"><img src="https://avatars1.githubusercontent.com/u/37545028?v=4" width="60px;" alt=""/><br /><sub><b>Kevin Neely</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=kneely" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://ariefrahmansyah.dev"><img src="https://avatars3.githubusercontent.com/u/8122852?v=4" width="60px;" alt=""/><br /><sub><b>Arief Rahmansyah</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ariefrahmansyah" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://vhanda.in"><img src="https://avatars2.githubusercontent.com/u/426467?v=4" width="60px;" alt=""/><br /><sub><b>Vishesh Handa</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=vHanda" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.linkedin.com/in/heroichitesh"><img src="https://avatars3.githubusercontent.com/u/37622734?v=4" width="60px;" alt=""/><br /><sub><b>Hitesh Kumar</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=HeroicHitesh" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://spencerwoo.com"><img src="https://avatars2.githubusercontent.com/u/32114380?v=4" width="60px;" alt=""/><br /><sub><b>Spencer Woo</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=spencerwooo" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://ingalless.com"><img src="https://avatars3.githubusercontent.com/u/22981941?v=4" width="60px;" alt=""/><br /><sub><b>ingalless</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ingalless" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=ingalless" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://jmg-duarte.github.io"><img src="https://avatars2.githubusercontent.com/u/15343819?v=4" width="60px;" alt=""/><br /><sub><b>José Duarte</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jmg-duarte" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jmg-duarte" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.yenly.wtf"><img src="https://avatars1.githubusercontent.com/u/6759658?v=4" width="60px;" alt=""/><br /><sub><b>Yenly</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=yenly" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.hikerpig.cn"><img src="https://avatars1.githubusercontent.com/u/2259688?v=4" width="60px;" alt=""/><br /><sub><b>hikerpig</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=hikerpig" title="Code">💻</a></td>
+    <td align="center"><a href="http://sigfried.org"><img src="https://avatars1.githubusercontent.com/u/1586931?v=4" width="60px;" alt=""/><br /><sub><b>Sigfried Gold</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Sigfried" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.tristansokol.com"><img src="https://avatars3.githubusercontent.com/u/867661?v=4" width="60px;" alt=""/><br /><sub><b>Tristan Sokol</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=tristansokol" title="Code">💻</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://umbrellait.com"><img src="https://avatars0.githubusercontent.com/u/49779373?v=4" width="60px;" alt=""/><br /><sub><b>Danil Rodin</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=umbrellait-danil-rodin" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.linkedin.com/in/scottjoewilliams/"><img src="https://avatars1.githubusercontent.com/u/2026866?v=4" width="60px;" alt=""/><br /><sub><b>Scott Williams</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=scott-joe" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://jackiexiao.github.io/blog"><img src="https://avatars2.githubusercontent.com/u/18050469?v=4" width="60px;" alt=""/><br /><sub><b>jackiexiao</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Jackiexiao" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://generativist.substack.com/"><img src="https://avatars3.githubusercontent.com/u/78835?v=4" width="60px;" alt=""/><br /><sub><b>John B Nelson</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jbn" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/asifm"><img src="https://avatars2.githubusercontent.com/u/3958387?v=4" width="60px;" alt=""/><br /><sub><b>Asif Mehedi</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=asifm" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/litanlitudan"><img src="https://avatars2.githubusercontent.com/u/4970420?v=4" width="60px;" alt=""/><br /><sub><b>Tan Li</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=litanlitudan" title="Code">💻</a></td>
+    <td align="center"><a href="http://shaunagordon.com"><img src="https://avatars1.githubusercontent.com/u/579361?v=4" width="60px;" alt=""/><br /><sub><b>Shauna Gordon</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=ShaunaGordon" title="Documentation">📖</a></td>
   </tr>
 </table>
 
@@ -172,13 +196,13 @@ If that sounds like something you're interested in, I'd love to have you along o
 Foam is licensed under the [MIT license](license).
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[graph-visualisation]: graph-visualisation "Graph visualisation"
-[backlinking]: backlinking "Backlinking"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[recipes]: recipes "Recipes"
-[frequently-asked-questions]: frequently-asked-questions "Frequently Asked Questions"
-[known-issues]: known-issues "Known Issues"
-[roadmap]: roadmap "Roadmap"
-[principles]: principles "Principles"
-[contribution-guide]: contribution-guide "Contribution Guide"
+[graph-visualisation]: graph-visualisation.md "Graph visualisation"
+[backlinking]: backlinking.md "Backlinking"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[recipes]: recipes.md "Recipes"
+[frequently-asked-questions]: frequently-asked-questions.md "Frequently Asked Questions"
+[known-issues]: known-issues.md "Known Issues"
+[roadmap]: roadmap.md "Roadmap"
+[principles]: principles.md "Principles"
+[contribution-guide]: contribution-guide.md "Contribution Guide"
 [//end]: # "Autogenerated link references"

docs/katex-math-rendering.md

@@ -0,0 +1,58 @@
+# Katex Math Rendering
+
+Apart from using the method mentioned in [[math-support]], we can also use KaTeX to render our math equations in Foam. The caveat is: we can't rely on GitHub Pages to host and deploy our website anymore, because the plugin we'll be using to let Jekyll support KaTeX doesn't play well together with GitHub Pages.
+
+The alternative solution is to using [[vercel]] for building and publishing our website, so before you start integrating KaTeX into your Foam project, please follow the instructions to host your Foam workspace on [[vercel]] first.
+
+## Adding required plugins
+
+Add the plugin `jekyll-katex` to your Foam workspace's `_config.yml` and `Gemfile` if you haven't done so already. For detailed instructions, please refer to the `#Adding a _config.yml` and `#Adding a Gemfile` in [[vercel]].
+
+## Loading KaTeX JS and CSS
+
+Because we are using KaTeX to render math, we will also need to import KaTeX's JS and CSS files from CDN. The official method to load these files is documented at: [KaTeX/KaTeX#starter-template](https://github.com/KaTeX/KaTeX#starter-template). In our case, we will need to add the following code snippet to our `_layouts/page.html`:
+
+```html
+<!-- _layouts/page.html -->
+---
+layout: default
+---
+
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css" integrity="sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X" crossorigin="anonymous">
+
+<!-- The loading of KaTeX is deferred to speed up page rendering -->
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.js" integrity="sha384-g7c+Jr9ZivxKLnZTDUhnkOnsh30B4H0rpLUpJ4jAIKs4fnJI+sEnkvrMWph2EDg4" crossorigin="anonymous"></script>
+
+<!-- To automatically render math in text elements, include the auto-render extension: -->
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/contrib/auto-render.min.js" integrity="sha384-mll67QQFJfxn0IYznZYonOWZ644AWYC+Pt2cHqMaRhXVrursRwvLnLaebdGIlYNa" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
+
+<!-- ... -->
+```
+
+## Adding liquid tags to wrap page content
+
+The plugin `jekyll-katex` focuses on rendering:
+
+- Single math equations wrapped inside `katex` liquid tags like {% raw %}`{% katex %} ... {% endkatex %}`{% endraw %}.
+- Or multiple math equations in paragraphs wrapped inside {% raw %}`{% katexmm %} ... {% endkatexmm %}`{% endraw %}.
+
+In our case, we'll be using the latter tag to wrap our {% raw %}`{{ content }}`{% endraw %}. Wrap {% raw %}`{{ content }}`{% endraw %} in the liquid tags inside `_layouts/page.html` like so:
+
+```html
+<!-- _layouts/page.html -->
+
+<!-- ... -->
+{% raw %}{% katexmm %} {{ content }} {% endkatexmm %}{% endraw %}
+<!-- ... -->
+```
+
+## Render equations in Foam's homepage as well
+
+You may have noticed that we only made modifications to the template `_layouts/page.html`, which means that `_layouts/home.html` won't have KaTeX support. If you wan't to render math in Foam's home page, you'll need to make the same modifications to `_layouts/home.html` as well.
+
+Finally, if all goes well, then our site hosted on Vercel will support rendering math equations with KaTeX after commiting these changes to GitHub. Here's a demo of the default template with KaTeX support: [Foam Template with KaTeX support](https://foam-template.vercel.app/).
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[math-support]: math-support.md "Math Support"
+[vercel]: vercel.md "Vercel"
+[//end]: # "Autogenerated link references"

docs/key-bindings.md

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

docs/known-issues.md

@@ -11,5 +11,5 @@
   - [x] ~~This is because the link styling hack in `assets/css/style.scss`~~
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[graph-visualisation]: graph-visualisation "Graph visualisation"
+[graph-visualisation]: graph-visualisation.md "Graph visualisation"
 [//end]: # "Autogenerated link references"

docs/link-formatting-and-autocompletion.md

@@ -6,14 +6,14 @@ Foam relies heavily on our [[recommended-extensions]], and each extension has sl
 
 ## Short version
 
-- Name your files in `lower-dash-case.md`. 
+- Name your files in `lower-dash-case.md`.
   - Read on: [How to name your files](#how-to-name-your-files)
 - Use [[wiki-links]] that match the file name exactly, without file extension: `[[lower-dash-case]]`
   - Read on: [How to format your links](#how-to-format-your-links)
   - Read on: [How to autocomplete your links correctly](#how-to-autocomplete-your-links-correctly)
 - Ensure every file has a `# Heading` element
   - This will be used as your document title.
-  
+
 ## How to name your files
 
 As described in [[foam-file-format]], **Foam file names should not contain spaces.** Because of the [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) extension's default behaviour, we recommend naming your files in lower-dash-case: `foam-file-format.md`.
@@ -68,8 +68,8 @@ Now your autocomplete will look like the below screenshot:
 If you created your Foam from the official [foam-template](https://github.com/foambubble/foam-template) project after 27th July 2020, this setting should be already correctly set.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links "Wiki Links"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[foam-file-format]: foam-file-format "Foam File Format"
-[principles]: principles "Principles"
-[//end]: # "Autogenerated link references"
+[wiki-links]: wiki-links.md "Wiki Links"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[foam-file-format]: foam-file-format.md "Foam File Format"
+[principles]: principles.md "Principles"
+[//end]: # "Autogenerated link references"

docs/link-reference-definition-improvements.md

@@ -53,7 +53,7 @@ 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 
+  - 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
@@ -68,7 +68,7 @@ The potential solution:
   - 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. 
+  - 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):
@@ -111,7 +111,7 @@ The potential solution:
       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
@@ -135,7 +135,7 @@ UI-wise, the publish targets could be picked in some similar fashion as the run/
 - [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links "Wiki Links"
-[link-reference-definitions]: link-reference-definitions "Link Reference Definitions"
-[backlinking]: backlinking "Backlinking"
+[wiki-links]: wiki-links.md "Wiki Links"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[backlinking]: backlinking.md "Backlinking"
 [//end]: # "Autogenerated link references"

docs/link-reference-definitions.md

@@ -16,7 +16,7 @@ The following example:
   [wiki-links]: wiki-links "Wiki Links"
   [github-pages]: github-pages "Github Pages"
   ```
-You can open the [raw markdown](https://raw.githubusercontent.com/foambubble/foam/master/foam-file-format.md) to see them at the bottom of this file
+You can open the [raw markdown](https://foambubble.github.io/foam/foam-file-format.md) to see them at the bottom of this file
 
 ## Specification
 
@@ -34,7 +34,7 @@ You can choose to generate link reference definitions with or without file exten
 - 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. 
+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`:
 
@@ -43,7 +43,7 @@ You can override this setting in your Foam workspace's `settings.json`:
 
 ### Ignoring files
 
-Sometimes, you may want to ignore certain files or folders, so that Foam doesn't generate link reference definitions to them. 
+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.
 
@@ -58,7 +58,7 @@ You can ignore the `_site` directory by adding the following to your `.vscode/se
   },
 ```
 
-After changing the setting in your workspace, you can run the [[workspace-janitor]] command to convert all existing definitions. 
+After changing the setting in your workspace, you can run the [[workspace-janitor]] command to convert all existing definitions.
 
 [[Todo]] _Implement a `foam.eclude
 
@@ -68,6 +68,7 @@ See [[link-reference-definition-improvements]] for further discussion on current
 
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[workspace-janitor]: workspace-janitor "Janitor"
-[link-reference-definition-improvements]: link-reference-definition-improvements "Link Reference Definition Improvements"
+[workspace-janitor]: workspace-janitor.md "Janitor"
+[Todo]: todo.md "Todo"
+[link-reference-definition-improvements]: link-reference-definition-improvements.md "Link Reference Definition Improvements"
 [//end]: # "Autogenerated link references"

docs/linking-between-published-workspaces.md

@@ -1,10 +1,10 @@
 # Linking between Published Workspaces (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/make-backlinks-more-prominent.md

@@ -20,5 +20,5 @@ In the future we'll want to improve this feature by
 
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
-[//end]: # "Autogenerated link references"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[//end]: # "Autogenerated link references"

docs/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/math-support.md

@@ -4,7 +4,7 @@ layout: mathjax
 
 # Math Support
 
-The published pages don't support math formulas by default. To enable this feature, you can add the following code snippet to the end of `_layouts/page.html`:
+Published Foam pages don't support math formulas by default. To enable this feature, you can add the following code snippet to the end of `_layouts/page.html`:
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
@@ -18,10 +18,25 @@ The published pages don't support math formulas by default. To enable this featu
 </script>
 ```
 
-Example of inline math: $e^{i \pi}+1=0$  
-Example of displayed math:  
+This approach uses the [MathJax](https://www.mathjax.org/) library to render anything delimited by ```$``` (customizable in the snippet above) pairs to inline math and ```$$``` to blocks of math (like a html div tag) using with the AMS-LaTeX dialect embedded within MathJax.
 
-$$ f_{\mathbf{X}}\left(x_{1}, \ldots, x_{k}\right)=\frac{\exp \left(-\frac{1}{2}(\mathbf{x}-\boldsymbol{\mu})^{\mathrm{T}} \mathbf{\Sigma}^{-1}(\mathbf{x}-\boldsymbol{\mu})\right)}{\sqrt{(2 \pi)^{k}|\mathbf{\Sigma}|}} $$  
+Example of inline math using `$...$`:
+
+`$e^{i \pi}+1=0$`, becomes $e^{i \pi}+1=0$
+
+Example of a math block using `$$...$$`:
+
+`$$ f_{\mathbf{X}}\left(x_{1}, \ldots, x_{k}\right)=\frac{\exp \left(-\frac{1}{2}(\mathbf{x}-\boldsymbol{\mu})^{\mathrm{T}} \mathbf{\Sigma}^{-1}(\mathbf{x}-\boldsymbol{\mu})\right)}{\sqrt{(2 \pi)^{k}|\mathbf{\Sigma}|}} $$`
+
+Becomes:
+
+$$ f_{\mathbf{X}}\left(x_{1}, \ldots, x_{k}\right)=\frac{\exp \left(-\frac{1}{2}(\mathbf{x}-\boldsymbol{\mu})^{\mathrm{T}} \mathbf{\Sigma}^{-1}(\mathbf{x}-\boldsymbol{\mu})\right)}{\sqrt{(2 \pi)^{k}|\mathbf{\Sigma}|}} $$
+
+## Alternative approaches
+
+There are other dialects of LaTeX (instead of AMS), and other JavaScript rendering libraries you may want to use. In a future version of Foam, we may support KaTeX syntax out of the box, but at this time, these integrations are left as an exercise to the user.
+
+## Why don't my Math expressions work on my Foam's home page?
 
 If you want the index page of your Foam site to render maths, you'll need to add that to `_layouts/home.html` as well, or change the layout of the index page to be "page" instead of "home" by putting this Front Matter on the top of your `readme.md/index.md`:
 
@@ -33,4 +48,4 @@ layout: page
 # Your normal title here
 ```
 
-Reference: [How to support latex in github-pages](https://stackoverflow.com/questions/26275645/how-to-support-latex-in-github-pages)
+Reference: [How to support latex in github-pages](https://stackoverflow.com/questions/26275645/how-to-support-latex-in-github-pages)

docs/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/meeting-notes/foam-core-2020-07-11.md

@@ -122,6 +122,6 @@ How others solve this:
 - Unique ids -- could support optionally as part of file name or front matter metadata. Should not be required.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: ../todo "Todo"
-[Index]: ../index "Foam"
+[todo]: ../todo.md "Todo"
+[Index]: ../index.md "Foam"
 [//end]: # "Autogenerated link references"

docs/migrating-from-obsidian.md

@@ -1,11 +1,11 @@
 # Migrating from Obsidian (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/migrating-from-roam.md

@@ -1,10 +1,10 @@
 # Migrating from Roam (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/mobile-apps.md

@@ -1,6 +1,6 @@
 # Mobile Apps
 
-We must always ask ourselves, [[build-vs-assemble]]. 
+We must always ask ourselves, [[build-vs-assemble]].
 
 This Roadmap item discusses existing assembled solutions, and some thoughts on future Foam mobile experience.
 
@@ -10,13 +10,15 @@ This Roadmap item discusses existing assembled solutions, and some thoughts on f
 
 #### Pros
 - Open source
-- Already a usable solution. 
+- Already a usable solution.
 - Provides functionality to edit, create, and browser markdown files.
 - Support journal mode, todo lists, and free writing
 - Syncs to GitHub repo
+- Supports Wiki Links
+- Supports Backlinks
+- Developer is happy to prioritize Foam compatibility
 
 #### Cons
-- Doesn't support [[wiki-links]] **(deal breaker, but support [coming soon](https://twitter.com/GitJournal_io/status/1280194357296062466))**
 - Doesn't generate link reference lists (but this is ok, since [[workspace-janitor]] as a GitHub action can solve this)
 - Not as sleek as Apple/Google notes, some keyboard state glitching on Android, etc.
 - Lack of control over roadmap. Established product with a paid plan, so may not be open to Foam-supportive changes and additions that don't benefit most users.
@@ -41,7 +43,6 @@ Given the effort vs reward ratio, it's a low priority for core team, but if some
 
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
-[wiki-links]: wiki-links "Wiki Links"
-[workspace-janitor]: workspace-janitor "Janitor"
-[//end]: # "Autogenerated link references"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
+[workspace-janitor]: workspace-janitor.md "Janitor"
+[//end]: # "Autogenerated link references"

docs/note-macros.md

@@ -0,0 +1,63 @@
+# Custom Note Macros
+
+This extension gives you the ability to create custom note macros. It was heavily inspired by Foam's [[daily-notes]] functionality.
+
+## Installation
+
+**This extension is not included in the template**
+
+To install search note-macros in vscode or head to [note-macros - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=NeelyInnovations.note-macros)
+
+## Instructions
+
+### Run macro From command pallette
+
+Simply use `Ctrl+P` or `Alt+P` depend on your os, and type `Note Macros: Run A Macro` then chose the macro you want to execute.
+
+### Create Custom Note Macros
+
+Create your own custom macros by adding them to your `settings.json` (Code|File > Preferences > User Settings). A full example can be found at [settings.json](https://github.com/kneely/note-macros/blob/master/settings.json)
+
+For example:
+
+This macro creates a Weekly note in the Weekly note Directory.
+
+```json
+{
+  "note-macros": {
+    "Weekly": [
+      {
+        "type": "note",
+        "directory": "Weekly",
+        "extension": ".md",
+        "name": "weekly-note",
+        "date": "yyyy-W"
+      }
+    ]
+  }
+}
+```
+
+For an explanation of the fields please go to [note-macros - Explanation of Fields](https://github.com/kneely/note-macros#explanation-of-fields)
+
+### Add Keybindings to Run your Macros
+
+in `keybindings.json` (Code|File > Preferences > Keyboard Shortcuts) add bindings to your macros:
+
+```json
+{
+  "key": "ctrl+cmd+/",
+  "command": "note-macros.Weekly"
+}
+```
+
+## Issues and Feedback
+
+If you have any issues or questions please look at the [README.md](https://github.com/kneely/note-macros#note-macros) on the [note-macros](https://github.com/kneely/note-macros) GitHub.
+
+If you run into any issues that are not fixed by referring to the README or feature requests please open an [issue](https://github.com/kneely/note-macros/issues).
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[daily-notes]: daily-notes.md "Daily notes"
+[//end]: # "Autogenerated link references"
+

docs/officially-support-alternative-templates.md

@@ -1,6 +1,6 @@
 # Officially Support Alternative Templates (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).
 
@@ -8,6 +8,6 @@ If you're interested in working on it, please start a conversation in [GitHub is
 
 
 [//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/packaged-desktop-app.md

@@ -1,11 +1,11 @@
 # Packaged Desktop App (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/predefined-user-snippets.md

@@ -48,12 +48,6 @@ We could provide snippets that expand out into the associated markdown syntax, l
 
 The JSON for these snippets can be found [here](https://github.com/foambubble/foam/pull/192#issuecomment-666736270).
 
-[//begin]: # 'Autogenerated link references for markdown compatibility'
-[custom-snippets]: custom-snippets 'Adding Custom Snippets'
-[//end]: # 'Autogenerated link references'
-[//begin]: # 'Autogenerated link references for markdown compatibility'
-[custom-snippets]: custom-snippets 'Adding Custom Snippets'
-[//end]: # 'Autogenerated link references'
-[//begin]: # 'Autogenerated link references for markdown compatibility'
-[custom-snippets]: custom-snippets 'Adding Custom Snippets'
-[//end]: # 'Autogenerated link references'
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[custom-snippets]: custom-snippets.md "Adding Custom Snippets"
+[//end]: # "Autogenerated link references"

docs/principles.md

@@ -49,9 +49,9 @@ While Foam uses tools popular among computer programmers, Foam should be inclusi
 - **Foam is for everyone** As a foam user, you support everyone's quest for knowledge and self-improvement, not only your own, or folks' who look like you. All participants in Foam repositories, discussion forums, physical and virtual meeting spaces etc are expected to respect each other as described in our [[code-of-conduct]]. **Foam is not for toxic tech bros.**
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[roadmap]: roadmap "Roadmap"
-[recipes]: recipes "Recipes"
-[recommended-extensions]: recommended-extensions "Recommended Extensions"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[code-of-conduct]: code-of-conduct "Code of Conduct"
+[roadmap]: roadmap.md "Roadmap"
+[recipes]: recipes.md "Recipes"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
+[contribution-guide]: contribution-guide.md "Contribution Guide"
+[code-of-conduct]: code-of-conduct.md "Code of Conduct"
 [//end]: # "Autogenerated link references"

docs/publishing-pages.md

@@ -23,5 +23,5 @@ Would be cool if Foam pages could be published. Some ideas here.
     - [ ] More granular access control? Email someone a link with a hash? [Testing](testing.md)
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[build-vs-assemble]: build-vs-assemble "Build vs Assemble"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
 [//end]: # "Autogenerated link references"

docs/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/random-thoughts.md

@@ -1 +1 @@
-# Random thoughts
+# Random thoughts

docs/reading-list.md

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

docs/recipes.md

@@ -23,6 +23,7 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 ## Take smart notes
 
 - Introduction to Zettelkasten [[todo]]
+- Clip webpages with [[web-clipper]]
 
 ## Discover
 - Explore your notes using [[graph-visualisation]]
@@ -36,10 +37,12 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 - Link documents with [[wiki-links]], using Foam's [[link-formatting-and-autocompletion]].
 - Use shortcuts for [[creating-new-notes]]
 - Instantly create and access your [[daily-notes]]
+- Use custom [[note-macros]] to create weekly, monthly etc. notes
 - Draw [[diagrams-in-markdown]]
 - Prettify your links, [[automatically-expand-urls-to-well-titled-links]]
 - Style your environment with [[custom-markdown-preview-styles]]
 - Paste and link [[images-from-your-clipboard]]
+- [[shows-image-preview-on-hover]]
 - [Markdown All-in-One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) features [[todo]] [[good-first-task]]
   - Manage checklists
   - Automatic Table of Contents
@@ -56,12 +59,19 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 
 ## Publish
 
-- Publish to [[github-pages]]
-- Publish to [[gitlab-pages]]
-- Publish your site with [[eleventy-and-netlify]]
-- Publish to [[azure-devops-wiki]]
+- Publish using official Foam template
+  - Publish to [[github-pages]]
+  - Publish to [[gitlab-pages]]
+  - Publish to [[azure-devops-wiki]]
+  - Publish to [[vercel]]
+- Publish using community templates
+  - [[eleventy-and-netlify]] by [@juanfrank77](https://github.com/juanfrank77)
+  - [[foam-gatsby-template]] by [@mathieudutour](https://github.com/mathieudutour)
+  - [foamy-nextjs](https://github.com/yenly/foamy-nextjs) by [@yenly](https://github.com/yenly)
 - Make the site your own by [[customising-styles]].
-- Math support [[math-support]]
+- Render math symbols, by either
+  - adding client-side [[math-support]] to the default [[github-pages]] site
+  - adding a custom Jekyll plugin to support [[katex-math-rendering]]
 
 ## Collaborate
 
@@ -88,29 +98,35 @@ Thought of a recipe but don't see a category for them? Add them here and we'll o
 _See [[contribution-guide]] and [[how-to-write-recipes]]._
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[contribution-guide]: contribution-guide "Contribution Guide"
-[how-to-write-recipes]: how-to-write-recipes "How to Write Recipes"
-[todo]: todo "Todo"
-[graph-visualisation]: graph-visualisation "Graph visualisation"
-[backlinking]: backlinking "Backlinking"
-[unlinked-references]: unlinked-references "Unlinked references (stub)"
-[reference-lists]: reference-lists "Reference Lists"
-[wiki-links]: wiki-links "Wiki Links"
-[link-formatting-and-autocompletion]: link-formatting-and-autocompletion "Link Formatting and Autocompletion"
-[creating-new-notes]: creating-new-notes "Creating New Notes"
-[daily-notes]: daily-notes "Daily notes"
-[diagrams-in-markdown]: diagrams-in-markdown "Diagrams in Markdown"
-[automatically-expand-urls-to-well-titled-links]: automatically-expand-urls-to-well-titled-links "Automatically Expand URLs to Well-Titled Links"
-[custom-markdown-preview-styles]: custom-markdown-preview-styles "Custom Markdown Preview Styles"
-[images-from-your-clipboard]: images-from-your-clipboard "Images from your Clipboard"
-[good-first-task]: good-first-task "Good First Task"
-[git-integration]: git-integration "Git integration"
-[gistpad]: gistpad "GistPad"
-[github-pages]: github-pages "Github Pages"
-[gitlab-pages]: gitlab-pages "GitLab Pages"
-[eleventy-and-netlify]: eleventy-and-netlify "Eleventy and Netlify"
-[azure-devops-wiki]: azure-devops-wiki "Azure DevOps Wiki"
-[customising-styles]: customising-styles "Customising Styles"
-[math-support]: math-support "Math Support"
-[capture-notes-with-drafts-pro]: capture-notes-with-drafts-pro "Capture Notes With Drafts Pro"
+[contribution-guide]: contribution-guide.md "Contribution Guide"
+[how-to-write-recipes]: how-to-write-recipes.md "How to Write Recipes"
+[todo]: todo.md "Todo"
+[web-clipper]: web-clipper.md "Web Clipper"
+[graph-visualisation]: graph-visualisation.md "Graph visualisation"
+[backlinking]: backlinking.md "Backlinking"
+[unlinked-references]: unlinked-references.md "Unlinked references (stub)"
+[reference-lists]: reference-lists.md "Reference Lists"
+[wiki-links]: wiki-links.md "Wiki Links"
+[link-formatting-and-autocompletion]: link-formatting-and-autocompletion.md "Link Formatting and Autocompletion"
+[creating-new-notes]: creating-new-notes.md "Creating New Notes"
+[daily-notes]: daily-notes.md "Daily notes"
+[note-macros]: note-macros.md "Custom Note Macros"
+[diagrams-in-markdown]: diagrams-in-markdown.md "Diagrams in Markdown"
+[automatically-expand-urls-to-well-titled-links]: automatically-expand-urls-to-well-titled-links.md "Automatically Expand URLs to Well-Titled Links"
+[custom-markdown-preview-styles]: custom-markdown-preview-styles.md "Custom Markdown Preview Styles"
+[images-from-your-clipboard]: images-from-your-clipboard.md "Images from your Clipboard"
+[shows-image-preview-on-hover]: shows-image-preview-on-hover.md "Shows Image Preview on Hover"
+[good-first-task]: good-first-task.md "Good First Task"
+[git-integration]: git-integration.md "Git integration"
+[gistpad]: gistpad.md "GistPad"
+[github-pages]: github-pages.md "Github Pages"
+[gitlab-pages]: gitlab-pages.md "GitLab Pages"
+[eleventy-and-netlify]: eleventy-and-netlify.md "Eleventy and Netlify"
+[azure-devops-wiki]: azure-devops-wiki.md "Azure DevOps Wiki"
+[vercel]: vercel.md "Vercel"
+[customising-styles]: customising-styles.md "Customising Styles"
+[math-support]: math-support.md "Math Support"
+[katex-math-rendering]: katex-math-rendering.md "Katex Math Rendering"
+[capture-notes-with-drafts-pro]: capture-notes-with-drafts-pro.md "Capture Notes With Drafts Pro"
+[foam-gatsby-template]: foam-gatsby-template.md "Foam Gatsby Template"
 [//end]: # "Autogenerated link references"

docs/recommended-extensions.md

@@ -10,3 +10,16 @@ This list is subject to change. Especially the Git ones.
 - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
 - [Git Lens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
 
+
+## Extensions For Additional Features
+
+These extensions are not (yet?) defined in `.vscode/extensions.json`, but have been used by others and shown to play nice with Foam.
+
+- [Emojisense](https://marketplace.visualstudio.com/items?itemName=bierner.emojisense)
+- [Markdown Emoji](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-emoji) (adds `:smile:` syntax, works with emojisense to provide autocomplete for this syntax)
+- [Mermaid Support for Preview](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
+- [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
+- [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
+- [VSCode PDF Viewing](https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf)
+- [Markdown Extended](https://marketplace.visualstudio.com/items?itemName=jebbs.markdown-extended) (with `kbd` option disabled, `kbd` turns wiki-links into non-clickable buttons)
+- [GitDoc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc) (easy version management via git auto commits)

docs/refactoring-via-language-server-protocol.md

@@ -1,10 +1,10 @@
 # Refactoring via Language Server Protocol (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/reference-lists.md

@@ -6,11 +6,11 @@ Use [[backlinking]] for handy reference lists:
 
 - Add links like [[recommendation]], [[book]] etc.
 - Create a page by that name and use its back links to see all todo's, recommendations, etc.
-- Alternatively, higlight the `[[link]]` and `Cmd`+`Shift`+`F` to find all references without creating a page.
+- Alternatively, highlight the `[[link]]` and `Cmd`+`Shift`+`F` to find all references without creating a page.
 - [[todo]]: [[materialized-backlinks]] would be very useful here.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[backlinking]: backlinking "Backlinking"
-[todo]: todo "Todo"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
+[backlinking]: backlinking.md "Backlinking"
+[todo]: todo.md "Todo"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

docs/referencing-notes-by-title.md

@@ -29,6 +29,6 @@
 - Can [MDX](https://github.com/mdx-js/mdx) help us here?
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[unlinked-references]: unlinked-references "Unlinked references (stub)"
-[renaming-files]: renaming-files "Renaming files (stub)"
-[//end]: # "Autogenerated link references"
+[unlinked-references]: unlinked-references.md "Unlinked references (stub)"
+[renaming-files]: renaming-files.md "Renaming files (stub)"
+[//end]: # "Autogenerated link references"

docs/renaming-files.md

@@ -1,10 +1,10 @@
 # Renaming files (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/roadmap.md

@@ -15,7 +15,7 @@ Items we plan on working next. Items in this stage don't need to have an owner,
 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,6 +27,7 @@ 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
 - Simplify [[foam-file-format]]
@@ -79,46 +80,46 @@ The community is working on a number of automated scripts to help you migrate to
 ### 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 "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)"
-[block-references]: block-references "Block References (stub)"
-[improved-backlinking]: improved-backlinking "Improved Backlinking (stub)"
-[make-backlinks-more-prominent]: make-backlinks-more-prominent "Make Backlinks More Prominent"
-[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)"
-[user-settings]: user-settings "User Settings (stub)"
-[link-reference-definitions]: link-reference-definitions "Link Reference Definitions"
-[predefined-user-snippets]: predefined-user-snippets "Pre-defined User Snippets"
-[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)"
-[migrating-from-onenote]: migrating-from-onenote "Migrating from OneNote"
-[foam-linter]: foam-linter "Foam Linter (stub)"
-[refactoring-via-language-server-protocol]: refactoring-via-language-server-protocol "Refactoring via Language Server Protocol (stub)"
+[build-vs-assemble]: build-vs-assemble.md "Build vs Assemble"
+[recipes]: recipes.md "Recipes"
+[cli]: cli.md "Command Line Interface"
+[workspace-janitor]: workspace-janitor.md "Janitor"
+[contribution-guide]: contribution-guide.md "Contribution Guide"
+[improve-default-workspace-settings]: improve-default-workspace-settings.md "Improve Default Workspace Settings (stub)"
+[git-integration]: git-integration.md "Git integration"
+[wiki-links]: wiki-links.md "Wiki Links"
+[foam-file-format]: foam-file-format.md "Foam File Format"
+[renaming-files]: renaming-files.md "Renaming files (stub)"
+[unlinked-references]: unlinked-references.md "Unlinked references (stub)"
+[block-references]: block-references.md "Block References (stub)"
+[improved-backlinking]: improved-backlinking.md "Improved Backlinking (stub)"
+[make-backlinks-more-prominent]: make-backlinks-more-prominent.md "Make Backlinks More Prominent"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
+[automatic-git-syncing]: automatic-git-syncing.md "Automatic Git Syncing (stub)"
+[git-flows-for-teams]: git-flows-for-teams.md "Git Flows for Teams (stub)"
+[user-settings]: user-settings.md "User Settings (stub)"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[predefined-user-snippets]: predefined-user-snippets.md "Pre-defined User Snippets"
+[officially-support-alternative-templates]: officially-support-alternative-templates.md "Officially Support Alternative Templates (stub)"
+[improved-static-site-generation]: improved-static-site-generation.md "Improved Static Site Generation (stub)"
+[mdx-by-default]: mdx-by-default.md "MDX by Default(stub)"
+[search-in-published-workspace]: search-in-published-workspace.md "Search in Published Workspace (stub)"
+[graph-in-published-workspace]: graph-in-published-workspace.md "Graph in Published Workspace (stub)"
+[linking-between-published-workspaces]: linking-between-published-workspaces.md "Linking between Published Workspaces (stub)"
+[publishing-permissions]: publishing-permissions.md "Publishing Permissions(stub)"
+[mobile-apps]: mobile-apps.md "Mobile Apps"
+[packaged-desktop-app]: packaged-desktop-app.md "Packaged Desktop App (stub)"
+[web-editor]: web-editor.md "Web Editor (stub)"
+[migrating-from-roam]: migrating-from-roam.md "Migrating from Roam (stub)"
+[migrating-from-obsidian]: migrating-from-obsidian.md "Migrating from Obsidian (stub)"
+[migrating-from-onenote]: migrating-from-onenote.md "Migrating from OneNote"
+[foam-linter]: foam-linter.md "Foam Linter (stub)"
+[refactoring-via-language-server-protocol]: refactoring-via-language-server-protocol.md "Refactoring via Language Server Protocol (stub)"
 [//end]: # "Autogenerated link references"

docs/search-for-notes.md

@@ -7,5 +7,5 @@ Run `Cmd` + `P` ( `Ctrl` +  `P` on Windows ) and type a name (like 'issues') to
 Run `Cmd` + `Shift` + `F` ( `Ctrl` + `Shift` + `F` on Windows ) and type a word (like 'links') to find all the notes that contain that term.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[todo]: todo "Todo"
+[todo]: todo.md "Todo"
 [//end]: # "Autogenerated link references"

docs/search-in-published-workspace.md

@@ -1,6 +1,6 @@
 # Search in Published Workspace (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).
 
@@ -8,6 +8,6 @@ If you're interested in working on it, please start a conversation in [GitHub is
 
 
 [//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/shows-image-preview-on-hover.md

@@ -0,0 +1,8 @@
+# Shows Image Preview on Hover
+
+Use extension: [Image preview](https://marketplace.visualstudio.com/items?itemName=kisstkondoros.vscode-gutter-preview) to shows image preview in the gutter and on hover
+
+It looks like this
+
+![picture 1](./assets/images/preview-image-on-hover.png)
+![picture 2](./assets/images/preview-image-in-glutter.png)

docs/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/unlinked-references.md

@@ -1,6 +1,6 @@
 # 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).
 
@@ -15,6 +15,6 @@ Implementing this is on the [[roadmap]], but for the time being you can achieve
 - 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/user-settings.md

@@ -1,9 +1,9 @@
 # User Settings (stub)
 
-**[[todo]] This [[roadmap]] item needs more specification work.** 
+**[[todo]] This [[roadmap]] item needs more specification work.**
 
 
 [//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/vercel.md

@@ -0,0 +1,85 @@
+# Vercel
+
+[Vercel](https://vercel.com/) is a static website hosting solution similar to [[github-pages]]. This recipe shows you how to deploy the default Foam website template to Vercel.
+
+## Setting up the project
+
+### Using Foam's template
+
+Generate a GitHub repository using the default [Foam template](https://github.com/foambubble/foam-template), this will be the workspace that we will be deploying with Vercel. This workspace is a barebone Jekyll source website, which means we can customize and install plugins just like any other Jekyll websites.
+
+As we won't be using GitHub Pages, we will be adding a few configuration files in order to help Vercel pick up on how to build our site.
+
+### Adding a `_config.yml`
+
+First, we'll need to add a `_config.yml` at the root directory. This is the Jekyll configuration file. In here, we will set the site's title, theme, repository and permalink options, and also tell Jekyll what plugins to use:
+
+```yaml
+# _config.yml
+title: Foam
+# All the plugins we will be installing now that we won't be using GitHub Pages
+plugins:
+  - jekyll-katex  # optional
+  - jekyll-default-layout
+  - jekyll-relative-links
+  - jekyll-readme-index
+  - jekyll-titles-from-headings
+  - jekyll-optional-front-matter
+# The default Jekyll theme we will be using
+theme: jekyll-theme-primer
+# The GitHub repository that we are hosting our foam workspace from
+repository: user/repo
+# Generate permalinks in format specified in: https://jekyllrb.com/docs/permalinks/#built-in-formats
+permalink: pretty
+```
+
+The `theme` specifies a theme for our deployed Jekyll website. 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. We can also choose a theme if you want from places like [Jekyll Themes](https://jekyllthemes.io/).
+
+The `plugins` specifies a list of Jekyll plugins that we will be installing in the next section. As we won't be using GitHub Pages, we'll need to install these plugins that GitHub Pages installs for us under the hood.
+
+_If you want to use LaTeX rendered with KaTeX (which is what the plugin `jekyll-katex` does), you can specify it here. And yes, one of the benefits of deploying with Vercel is that we can use KaTeX to render LaTeX! More on: [[katex-math-rendering]]_
+
+### Adding a `Gemfile`
+
+Next up, we'll create another new file called `Gemfile` in the root directory. This is where we will let Vercel know what plugins to install when building our website.
+
+In our `Gemfile`, we need to specify our Ruby packages:
+
+```ruby
+# Gemfile
+source "https://rubygems.org"
+gem "jekyll"
+gem "kramdown-parser-gfm"
+gem "jekyll-theme-primer"
+gem "jekyll-optional-front-matter"
+gem "jekyll-default-layout"
+gem "jekyll-relative-links"
+gem "jekyll-readme-index"
+gem "jekyll-titles-from-headings"
+gem "jekyll-katex"  # Optional, the package that enables KaTeX math rendering
+```
+
+### Enable math rendering with KaTeX (optional)
+
+Besides adding the plugin `jekyll-katex` in `_config.yml` and `Gemfile`, we'll also have to follow the guides in [[katex-math-rendering]] to let our site fully support using KaTeX to render math equations.
+
+### Commiting changes to GitHub repo
+
+Finally, commit the newly created files to GitHub.
+
+## Importing project to Vercel
+
+First, import our foam workspace (GitHub repository) to Vercel with [Vercel's _Import Git Repository_](https://vercel.com/import/git). Paste our GitHub repo's url and Vercel will automatically pull and analyze the tool we use to deploy our website. (In our case: Jekyll.)
+
+Next, select the folder to deploy from if prompted. If we are using the default template, then Vercel will default to the root directory of our Foam workspace.
+
+Finally, if all is successful, Vercel will show the detected framework: Jekyll. Press `Deploy` to proceed on publishing our project.
+
+![](assets/images/vercel-detect-preset.png)
+
+And now, Vercel will take care of building and rendering our foam workspace each time on push. Vercel will publish our site to `xxx.vercel.app`, we can also define a custom domain name for our Vercel website.
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[github-pages]: github-pages.md "Github Pages"
+[katex-math-rendering]: katex-math-rendering.md "Katex Math Rendering"
+[//end]: # "Autogenerated link references"

docs/web-clipper.md

@@ -0,0 +1,14 @@
+# Web Clipper
+
+You can convert any web content into Markdown for storing them in your notes.
+There are a couple of options when it comes to clipping web pages:
+
+[Web Clipper - Visual Studio
+Marketplace](https://marketplace.visualstudio.com/items?itemName=jsartelle.web-clipper)
+- This is a Web Clipper as a VSCode extension, takes a webpage URL and outputs
+Markdown. Uses [mercury](https://github.com/postlight/mercury-parser)
+
+[deathau/markdown-clipper: A Web extension to clip websites and convert them to
+markdown](https://github.com/deathau/markdown-clipper) - This is a Web Extension
+that can be used in multiple browsers to the extract any webpage's content in
+markdown.

docs/web-editor.md

@@ -1,10 +1,10 @@
 # Web Editor (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/wiki-links.md

@@ -3,7 +3,7 @@
 Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[media-wiki]]` links).
 
 - Type `[[` and start typing a file name for autocompletion.
-  - Note that your file names should be in `lower-dash-case.md`, and your wiki links should reference file names exactly: `[[lower-dash-case]]`, not `[[Lower Dash Case]]`. 
+  - Note that your file names should be in `lower-dash-case.md`, and your wiki links should reference file names exactly: `[[lower-dash-case]]`, not `[[Lower Dash Case]]`.
   - See [[link-formatting-and-autocompletion]] for more information, and how to setup your link autocompletions to make this easier.
 - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on file name to navigate to file (`F12` also works while your cursor is on the file name)
 - `Cmd` + `Click` ( `Ctrl` + `Click` on Windows ) on non-existent file to create that file in the workspace.
@@ -26,8 +26,8 @@ The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.f
 - See [[link-reference-definition-improvements]] for further discussion on current problems and potential solutions.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[link-formatting-and-autocompletion]: link-formatting-and-autocompletion "Link Formatting and Autocompletion"
-[link-reference-definitions]: link-reference-definitions "Link Reference Definitions"
-[foam-file-format]: foam-file-format "Foam File Format"
-[link-reference-definition-improvements]: link-reference-definition-improvements "Link Reference Definition Improvements"
+[link-formatting-and-autocompletion]: link-formatting-and-autocompletion.md "Link Formatting and Autocompletion"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[foam-file-format]: foam-file-format.md "Foam File Format"
+[link-reference-definition-improvements]: link-reference-definition-improvements.md "Link Reference Definition Improvements"
 [//end]: # "Autogenerated link references"

docs/workspace-janitor.md

@@ -30,11 +30,11 @@ The Janitor can be installed from [NPM](https://www.npmjs.com/) and executed as
 > 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 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 "Link Reference Definitions"
-[materialized-backlinks]: materialized-backlinks "Materialized Backlinks (stub)"
+[link-reference-definitions]: link-reference-definitions.md "Link Reference Definitions"
+[materialized-backlinks]: materialized-backlinks.md "Materialized Backlinks (stub)"
 [//end]: # "Autogenerated link references"

lerna.json

@@ -4,5 +4,5 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.3.1"
+  "version": "0.7.2"
 }

package.json

@@ -14,6 +14,9 @@
     "build:core": "yarn workspace foam-core build",
     "watch:core": "yarn workspace foam-core start",
     "test:core": "yarn workspace foam-core test",
+    "vscode:package-extension": "yarn workspace foam-vscode package-extension",
+    "vscode:install-extension": "yarn workspace foam-vscode install-extension",
+    "vscode:publish-extension": "yarn workspace foam-vscode publish-extension",
     "clean": "lerna run clean",
     "build": "lerna run build",
     "test": "lerna run test",
@@ -25,7 +28,7 @@
     "lerna": "^3.22.1"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=12"
   },
   "husky": {
     "hooks": {

packages/foam-cli/README.md

@@ -19,7 +19,7 @@ $ npm install -g foam-cli
 $ foam COMMAND
 running command...
 $ foam (-v|--version|version)
-foam-cli/0.3.0 darwin-x64 node-v12.18.0
+foam-cli/0.7.2 darwin-x64 node-v12.18.2
 $ foam --help [COMMAND]
 USAGE
   $ foam COMMAND
@@ -65,7 +65,7 @@ EXAMPLE
   $ foam-cli janitor path-to-foam-workspace
 ```
 
-_See code: [src/commands/janitor.ts](https://github.com/foambubble/foam/blob/v0.3.0/src/commands/janitor.ts)_
+_See code: [src/commands/janitor.ts](https://github.com/foambubble/foam/blob/v0.7.2/src/commands/janitor.ts)_
 
 ## `foam migrate [WORKSPACEPATH]`
 
@@ -84,7 +84,7 @@ EXAMPLE
   Successfully generated link references and heading!
 ```
 
-_See code: [src/commands/migrate.ts](https://github.com/foambubble/foam/blob/v0.3.0/src/commands/migrate.ts)_
+_See code: [src/commands/migrate.ts](https://github.com/foambubble/foam/blob/v0.7.2/src/commands/migrate.ts)_
 <!-- commandsstop -->
 
 ## Development

packages/foam-cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "foam-cli",
   "description": "Foam CLI",
-  "version": "0.3.0",
+  "version": "0.7.2",
   "author": "Jani Eväkallio @jevakallio",
   "bin": {
     "foam": "./bin/run"
@@ -11,7 +11,7 @@
     "@oclif/command": "^1",
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^3",
-    "foam-core": "^0.3.0",
+    "foam-core": "^0.7.2",
     "ora": "^4.0.4",
     "tslib": "^1"
   },
@@ -33,10 +33,10 @@
     "typescript": "^3.3"
   },
   "peerDependencies": {
-    "foam-core": "^0.2.0"
+    "foam-core": "*"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=12.0.0"
   },
   "files": [
     "/bin",

packages/foam-cli/src/commands/janitor.ts

@@ -1,10 +1,13 @@
 import { Command, flags } from '@oclif/command';
-import * as ora from 'ora';
+import ora from 'ora';
 import {
-  initializeNoteGraph,
+  bootstrap,
+  createConfigFromFolders,
   generateLinkReferences,
   generateHeading,
-  applyTextEdit
+  applyTextEdit,
+  Services,
+  FileDataStore,
 } from 'foam-core';
 import { writeFileToDisk } from '../utils/write-file-to-disk';
 import { isValidDirectory } from '../utils';
@@ -21,7 +24,8 @@ export default class Janitor extends Command {
   static flags = {
     'without-extensions': flags.boolean({
       char: 'w',
-      description: 'generate link reference definitions without extensions (for legacy support)'
+      description:
+        'generate link reference definitions without extensions (for legacy support)',
     }),
     help: flags.help({ char: 'h' }),
   };
@@ -36,7 +40,11 @@ export default class Janitor extends Command {
     const { workspacePath = './' } = args;
 
     if (isValidDirectory(workspacePath)) {
-      const graph = await initializeNoteGraph(workspacePath);
+      const config = createConfigFromFolders([workspacePath]);
+      const services: Services = {
+        dataStore: new FileDataStore(config),
+      };
+      const graph = (await bootstrap(config, services)).notes;
 
       const notes = graph.getNotes().filter(Boolean); // removes undefined notes
 
@@ -54,7 +62,11 @@ export default class Janitor extends Command {
       const fileWritePromises = notes.map(note => {
         // Get edits
         const heading = generateHeading(note);
-        const definitions = generateLinkReferences(note, graph, !flags['without-extensions']);
+        const definitions = generateLinkReferences(
+          note,
+          graph,
+          !flags['without-extensions']
+        );
 
         // apply Edits
         let file = note.source.text;