Adds link to mermaid

Co-authored-by: Jani Eväkallio <jani.evakallio@gmail.com>

.all-contributorsrc

@@ -186,7 +186,81 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "TaiChi-IO",
+      "name": "TaiChi-IO",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/65092992?v=4",
+      "profile": "https://github.com/TaiChi-IO",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "juanfrank77",
+      "name": "Juan F Gonzalez ",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/12146882?v=4",
+      "profile": "https://github.com/juanfrank77",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "SanketDG",
+      "name": "Sanket Dasgupta",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/8980971?v=4",
+      "profile": "https://sanketdg.github.io",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "nstafie",
+      "name": "Nicholas Stafie",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/10801854?v=4",
+      "profile": "https://github.com/nstafie",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "francishamel",
+      "name": "Francis Hamel",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/36383308?v=4",
+      "profile": "https://github.com/francishamel",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "digiguru",
+      "name": "digiguru",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/619436?v=4",
+      "profile": "http://digiguru.co.uk",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "chirag-singhal",
+      "name": "CHIRAG SINGHAL",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/42653703?v=4",
+      "profile": "https://github.com/chirag-singhal",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "lostintangent",
+      "name": "Jonathan Carter",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/116461?v=4",
+      "profile": "https://github.com/lostintangent",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
-  "contributorsPerLine": 7
+  "contributorsPerLine": 7,
+  "skipCi": true
 }

docs/_layouts/foam.html

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

docs/_layouts/home.html

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

docs/_layouts/mathjax.html

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

docs/_layouts/page.html

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

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

@@ -0,0 +1,142 @@
+# Capture Notes With Drafts Pro
+
+## Context
+
+* You use [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) to manage your notes
+* You wish to adopt a practice such as [A writing inbox for transient and incomplete notes](https://notes.andymatuschak.org/A%20writing%20inbox%20for%20transient%20and%20incomplete%20notes)
+* You wish to use [Drafts Pro](https://docs.getdrafts.com/) to capture quick notes into your Foam notes from your iOS device
+
+## Required Extensions
+
+* [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode)
+
+## Other tools
+
+* We assume you are familiar with how to use GitHub (if you are using Foam this is implicit)
+* You have an iOS device with [Drafts](https://getdrafts.com/)
+* You have upgraded to [Drafts Pro](https://docs.getdrafts.com/draftspro) (needed to edit actions).
+
+## Instructions
+
+1. [Create a new action in Drafts](https://docs.getdrafts.com/docs/actions/editing-actions)
+2. Add a single [step](https://docs.getdrafts.com/actions/steps/) of type Script
+3. Edit the script adding the code from the block below
+4. Edit settings at the top of the script to suit your preferences
+5. Set other Action options in Drafts as you wish
+6. Save the Action
+7. In GitHub [create a Personal Access Token](https://github.com/settings/tokens) and give it `repo` scope - make a note of the token
+8. In Drafts create a note
+9. Select the action you created in steps 1-6
+10. On the first run you will need to add the following information:
+    1. your GitHub username
+    2. the repository name of your Foam repo
+    3. the GitHub access token from step 7
+    4. An author name
+11. Check your Github repo for a commit
+12. If you are publishing your Foam to the web you may want to edit your publishing configuration to exclude inbox files - as publishing (and method) is a user choice that is beyond the scope of this recipe
+
+## Code for Drafts Action
+
+```javascript
+// adapted from https://forums.getdrafts.com/t/script-step-post-to-github-without-working-copy/3594
+// post to writing inbox in Foam digital garden
+
+/*
+ * edit these lines to suit your preferences
+ */
+const inboxFolder = "inbox/";   // the folder in your Foam repo where notes are saved. MUST have trailing slash, except for root of repo use ''
+const requiredTags = ['inbox']; // all documents will have these added in addition to tags from the Drafts app
+const addLinkToInbox = true;    // true = created note will have link to [[index]], false = no link
+const addTimeStamp = true;      // true = add a note of capture date/time at foot of note
+
+/*
+ * stop editing
+ */
+
+const credential = Credential.create("GitHub garden repo", "The repo name, and its credentials, hosting your Foam notes");
+credential.addTextField("username", "GitHub Username");
+credential.addTextField('repo', 'Repo name');
+credential.addPasswordField("key", "GitHub personal access token");
+credential.addTextField('author', 'Author');
+credential.authorize();
+
+const githubKey = credential.getValue('key');
+const githubUser = credential.getValue('username');
+const repo = credential.getValue('repo');
+const author = credential.getValue('author');
+
+const http = HTTP.create(); // create HTTP object
+const base = 'https://api.github.com';
+
+
+const posttime = new Date();
+const title = draft.title;  
+const txt = draft.processTemplate("[[line|3..]]");
+const mergedTags = [...draft.tags, ...requiredTags];
+const slugbase = title.toLowerCase().replace(/\s/g, "-");
+
+const datestr = `${posttime.getFullYear()}-${pad(posttime.getMonth() + 1)}-${pad(posttime.getDate())}`;
+const timestr = `${pad(posttime.getHours())}:${pad(posttime.getMinutes())}:00`;
+const yr = `${posttime.getFullYear()}`;
+const pdOffset = posttime.getTimezoneOffset();
+const offsetChar = pdOffset >= 0 ? '-' : '+';
+var pdHours = Math.floor(pdOffset/60);
+console.log(pdHours);
+pdHours = pdHours >= 0 ? pdHours : pdHours * -1;
+console.log(pdHours);
+const tzString = `${offsetChar}${pad(pdHours)}:00`;
+const postdate = `${datestr}T${timestr}${tzString}`;
+
+
+const slug = `${slugbase}`
+const fn = `${slug}.md`;
+let preamble = `# ${title} \n\n`;
+
+mergedTags.forEach(function(item,index){
+   preamble += `#${item} `;
+  }
+);
+
+if (addLinkToInbox) {
+    preamble += "\n\n[[inbox]]\n";
+}
+
+preamble += "\n\n";
+
+var doc = `${preamble}${txt}`;
+
+if (addTimeStamp){
+
+    doc += `\n\nCaptured: ${postdate}\n`
+}
+
+const options = {
+    url: `https://api.github.com/repos/${githubUser}/${repo}/contents/${inboxFolder}${fn}`,
+    method: 'PUT',
+    data: {
+        message: `Inbox from Drafts ${datestr}`,
+        content: Base64.encode(doc)
+    },
+    headers: {
+        'Authorization': `token ${githubKey}`
+    }
+};
+
+var response = http.request(options);
+
+if (response.success) {
+    // yay
+} else {
+    console.log(response.statusCode);
+    console.log(response.error);
+}
+
+function pad(n) {
+    let str = String(n);
+    while (str.length < 2) {
+        str = `0${str}`;
+    }
+    return str;
+}
+
+```

docs/eleventy-and-netlify.md

@@ -0,0 +1,19 @@
+# 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/). 
+
+With this template you can
+- Have control over what to publish and what to keep private 
+- Customize the styling of the site to your own liking
+
+## Publishing your foam
+
+When you're ready to publish, import the GitHub repository you created with **foam-eleventy-template** into your Netlify account. (Create one if you don't have it already.)
+
+Once that's done, all you have to do is make changes to your workspace in VS COde and push them to the main branch on GitHub. Netlify will recognize the changes, deploy them automatically and give you a link where your Foam is published.
+
+
+That's it!
+
+You can now see it online and use that link to share it with your friends, so that they can see it too.
+

docs/foam-core.md

@@ -20,7 +20,7 @@
   - Can be either [[wiki-links]] or relative `[markdown](links.md)` style
   - We need to know about the edges (connections) as well as nodes
     - What link points to what other file, etc.
-    - Needs to have the exact link text, e.g. even if `[[some-page]]` or `[[some-page.md]]` or `[[Some Page]]` point to the same document (`./some-page.md`), we need to know which format was used, so link reference definitions can be generated correctly
+    - Needs to have the exact link text, e.g. even if `[[some-page]]` or `[[some-page.md]]` or `[[Some Page]]` point to the same document (`./some-page.md`), we need to know which format was used, so [[link-reference-definitions]] can be generated correctly
 - Treat each file as semi-structured data
   - Title, headings, lists, paragraphs, images, links, data, code
   - Also, possible Foam-specific meta stuff, like "backlinks" or "block references".
@@ -61,7 +61,7 @@ Here are some example use cases that the core should support. They don't need to
 
 - Adding and editing page content
   - [[materialized-backlinks]]
-  - [[wiki-links]] reference definitions
+  - [[link-reference-definitions]] for [[wiki-links]]
   - [Frontmatter](https://jekyllrb.com/docs/front-matter/)
 - Finding all documents with `#tag`
 - Finding all documents with instances of `[[link]]`

docs/foam-file-format.md

@@ -14,25 +14,7 @@ Here are a few specific constraints, mainly because our tooling is a bit fragmen
 - **File name should have extension `.md` or `.markdown`**
   - This is a temporary limitation and will be lifted in future versions.
   - At least `.mdx` will be supported, but ideally we'll support any file that you can map to `Markdown` language mode in VS Code
-- **In addition to normal Markdown Links syntax you can use `[[media-wiki]]` links.**
-  - When you do, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file.
-    - Here's an example:
-      - [[wiki-links]]
-      - [[github-pages]]
-    - This will generate the following references:
-      ```md
-      [wiki-links]: wiki-links "Wiki Links"
-      [github-pages]: github-pages "Github Pages"
-      ```
-    - The three components are `[link-label]: link-target "Link Title"
-      - **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wiki-link]]` notation
-      - **link destination** The target of the matched link
-        - Right now we generate link destinations without file extension. This is a choice, see [discussion here](https://foambubble.github.io/foam/wiki-links#why-dont-wiki-links-work-on-github).
-      - **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime)
-    - Open the [raw markdown](https://raw.githubusercontent.com/foambubble/foam/master/foam-file-format.md) to see them at the bottom of this file
-    - In the near future, these can be batch generated for all workspace files (WIP)
-      - For the time being, if you want to get [[wiki-links]] support across all files, you'll need to generate the link reference definitions yourself.
-      - If you end up writing a batch job for this, please share your solution, as this is something we'll need to implement soon!
+- **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"
 [wiki-links]: wiki-links "Wiki Links"

docs/gistpad.md

@@ -0,0 +1,51 @@
+# GistPad
+
+[GistPad](https://aka.ms/gistpad) is a Visual Studio Code extension that allows you to edit your GitHub gists and repos, without needing to clone anything locally. It provides support for editing Foam workspaces, complete with `[[link]]` [completion/navigation](https://github.com/vsls-contrib/gistpad#links), [daily pages](https://github.com/vsls-contrib/gistpad#daily-pages), [pasting images](https://github.com/vsls-contrib/gistpad#pasting-images-1) and [backlinks](https://github.com/vsls-contrib/gistpad#backlinks). If you'd like to persist your notes in a GitHub repository, and automatically sync changes without needing to manually commit/push/pull, then GistPad might be an option worth exploring.
+
+<img width="700px" src="https://user-images.githubusercontent.com/116461/87234714-96ba9400-c388-11ea-92c3-544d9a3bb633.png" />
+
+## Getting started
+
+To start using GistPad for your Foam-based knowledge base, simply perform the following steps:
+
+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: Manage 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`)
+
+Your new repo will be created in your GitHub account, and the `Foam` welcome page will be automatically opened. If you already have an existing Foam workspace in GitHub, then when you run step #3 above, simply select or specify the name of the GitHub repository instead.
+
+> Note: If you have any and all feedback on how GistPad can be improved to support your Foam workflow, please don't hesitate to [let us know](https://github.com/vsls-contrib/gistpad)! 👍
+
+<img width="700px" src="https://user-images.githubusercontent.com/116461/87863222-c1b76180-c90d-11ea-87d9-04bee1c58a0d.png" />
+
+## Managing your workspace
+
+Once you've opened/created the Foam repository, it will appear in the `Repositories` view of the `GistPad` tab (the one with the little notebook icon). From this tree view, you can add/edit/delete/rename new pages, upload local files, as well as view the backlinks for each page (they appear as child notes of a page).
+
+<img width="250px" src="https://user-images.githubusercontent.com/116461/87234704-83a7c400-c388-11ea-90a8-2a660bef4dc5.png" />
+
+## Editing your workspace
+
+When you create or open a page, you can edit the markdown content as usual, as well as [paste images](https://github.com/vsls-contrib/gistpad#pasting-images-1), and create [`[[links]]` to other pages](https://github.com/vsls-contrib/gistpad#links). When you type `[[`, you'll recieve auto-completion for the existing pages in your workspace, and you can also automatically create new pages by simply creating a link to it.
+
+Since you're using the Visual Studio Code markdown editor, you can benefit from all of the rich language services (e.g. syntax highlighting, header collapsing), as well as the extension ecosystem (e.g. [Emojisense](https://marketplace.visualstudio.com/items?itemName=bierner.emojisense)).
+
+## Navigating your workspace
+
+When editing a file, you can easily navigate `[[links]]` by hovering over them to see a preview of their contents and/or `cmd+clicking` on them in order to jump to the respective page. Furthermore, when you add a link to a page, a [backlink](https://github.com/vsls-contrib/gistpad#backlinks) is automatically added to it.
+
+You can view a page's backlinks using either of the following techniques:
+
+1. Expanding the file's node in the `Repositories` tree, since it's child nodes will represent backlinks. This makes it easy to browse your pages and their backlinks in a single hierachical view.
+
+1. Opening a file, and then viewing it's backlinks list at the bottom of the editor view. This makes it easy to read a page and then see its backlinks in a contextually rich way.
+
+## 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.
+
+<img width="700px" src="https://user-images.githubusercontent.com/116461/87234721-b356cc00-c388-11ea-946a-e7f9c92258a6.png" />

docs/gitlab-pages.md

@@ -0,0 +1,51 @@
+# GitLab Pages
+
+You don't have to use GitHub to serve Foam pages. You can also use GitLab.
+
+## Setup a project
+
+### Generate the directory from GitHub
+
+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) 
+
+```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
+```
+
+You can choose a theme if you want from places like [Jekyll Themes](https://jekyllthemes.io/)
+
+### Add a Gemlock file
+
+Add another file to the root directory (the one with `readme.md` in it) called `Gemfile` (no extension)
+
+```ruby
+source "https://rubygems.org"
+
+gem "jekyll"
+gem "jekyll-theme-minimal"
+gem "jekyll-optional-front-matter"
+``` 
+
+Commit the file and push it to gitlab.
+
+## Setup CI/CD
+
+1. From the project home in GitLab click `Set up CI/CD`
+2. Choose `Jekyll` as your template from the template dropdown
+3. Click `commit`
+4. Now when you go to CI / CD > Pipelines, you should see the code running
+
+## Troubleshooting
+
+- *Could not locate Gemfile* - You didn't follow the steps above to [#Add a Gemlock file]
+- *Conversion error: Jekyll::Converters::Scss encountered an error while converting* You need to reference a theme.
+- *Pages are running in CI/CD, but I only ever see `test`, and never deploy* - Perhaps you've renamed the main branch (from master) - check the settings in `.gitlab-ci.yml` and ensure the deploy command is running to the branch you expect it to.
+- *I deployed, but my .msd files don't seem to be being converted into .html files* - You need a gem that GitHub installs by default - check `gem "jekyll-optional-front-matter"` appears in the `Gemfile`

docs/images-from-your-clipboard.md

@@ -0,0 +1,5 @@
+# Images from your Clipboard
+
+You can directly link and paste images that are copied to the clipboard using the [Paste
+Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
+extension.

docs/inbox.md

@@ -3,7 +3,6 @@
 Uncategorised thoughts, to be added
 
 - Release notes
-- Automatic updates
 - Markdown Preview
   - It's possible to customise the markdown preview styling. **Maybe make it use local foam workspace styles for live preview of the site??**
     - See: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-preview-github-styles
@@ -11,10 +10,14 @@ Uncategorised thoughts, to be added
 - Investigate other similar extensions:
   - [Unotes](https://marketplace.visualstudio.com/items?itemName=ryanmcalister.Unotes)
   - [vscode-memo](https://github.com/svsool/vscode-memo)
+  - [gistpad wiki](https://github.com/jevakallio/gistpad/tree/master/src/repos/wiki)
+- Developer documentation
+  - 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
 - Foam as a (VS Code) language
   - Syntax highlighting
-  - Autocompletion
-    - Get rid of mediawiki links in favor of write time tooling
   - Snippets
 - Future architecture
   - Could we do publish-related settings as a pre-push git hook, e.g. generating footnote labels

docs/index.md

@@ -62,10 +62,12 @@ These instructions assume you have a GitHub account, and you have Visual Studio
 
    <a class="github-button" href="https://github.com/foambubble/foam-template/generate" data-icon="octicon-repo-template" data-size="large" aria-label="Use this template foambubble/foam-template on GitHub">Use this template</a>
 
-   (If you want to keep your thoughts to yourself, remember to set the repository private, or if you don't want to use GitHub to host your workspace at all, choose **Download as ZIP** instead of **Use this template**.)
+   *If you want to keep your thoughts to yourself, remember to set the repository private, or if you don't want to use GitHub to host your workspace at all, choose **Download as ZIP** instead of **Use this template**.*
 
 2. [Clone the repository locally](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) and open it in VS Code.
 
+    *Open the repository as a folder using the `File > Open...` menu item. In VS Code, "open workspace" refers to [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces).*
+
 3. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one)
 
 After setting up the repository, open `.vscode/settings.json` and edit, add or remove any settings you'd like for your Foam workspace.
@@ -106,29 +108,39 @@ If that sounds like something you're interested in, I'd love to have you along o
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://jevakallio.dev/"><img src="https://avatars1.githubusercontent.com/u/1203949?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Jani Eväkallio</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://joeprevite.com/"><img src="https://avatars3.githubusercontent.com/u/3806031?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Joe Previte</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/riccardoferretti"><img src="https://avatars3.githubusercontent.com/u/457005?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Riccardo</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://ojanaho.com/"><img src="https://avatars0.githubusercontent.com/u/2180090?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Janne Ojanaho</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://bypaulshen.com/"><img src="https://avatars3.githubusercontent.com/u/2266187?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Paul Shen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=paulshen" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/coffenbacher"><img src="https://avatars0.githubusercontent.com/u/245867?v=4?s=60" width="60px;" alt=""/><br /><sub><b>coffenbacher</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=coffenbacher" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://mathieu.dutour.me/"><img src="https://avatars2.githubusercontent.com/u/3254314?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Mathieu Dutour</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=mathieudutour" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://jevakallio.dev/"><img src="https://avatars1.githubusercontent.com/u/1203949?v=4" width="60px;" alt=""/><br /><sub><b>Jani Eväkallio</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://joeprevite.com/"><img src="https://avatars3.githubusercontent.com/u/3806031?v=4" width="60px;" alt=""/><br /><sub><b>Joe Previte</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/riccardoferretti"><img src="https://avatars3.githubusercontent.com/u/457005?v=4" width="60px;" alt=""/><br /><sub><b>Riccardo</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://ojanaho.com/"><img src="https://avatars0.githubusercontent.com/u/2180090?v=4" width="60px;" alt=""/><br /><sub><b>Janne Ojanaho</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://bypaulshen.com/"><img src="https://avatars3.githubusercontent.com/u/2266187?v=4" width="60px;" alt=""/><br /><sub><b>Paul Shen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=paulshen" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/coffenbacher"><img src="https://avatars0.githubusercontent.com/u/245867?v=4" width="60px;" alt=""/><br /><sub><b>coffenbacher</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=coffenbacher" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://mathieu.dutour.me/"><img src="https://avatars2.githubusercontent.com/u/3254314?v=4" width="60px;" alt=""/><br /><sub><b>Mathieu Dutour</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=mathieudutour" title="Documentation">📖</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://github.com/presidentelect"><img src="https://avatars2.githubusercontent.com/u/1242300?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Michael Hansen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=presidentelect" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://klickverbot.at/"><img src="https://avatars1.githubusercontent.com/u/19335?v=4?s=60" width="60px;" alt=""/><br /><sub><b>David Nadlinger</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dnadlinger" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://pluckd.co/"><img src="https://avatars2.githubusercontent.com/u/20598571?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Fernando</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=MrCordeiro" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/jfgonzalez7"><img src="https://avatars3.githubusercontent.com/u/58857736?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Juan Gonzalez</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jfgonzalez7" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://www.louiechristie.com/"><img src="https://avatars1.githubusercontent.com/u/6807448?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Louie Christie</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=louiechristie" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SuperSandro2000" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/Skn0tt"><img src="https://avatars1.githubusercontent.com/u/14912729?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Simon Knott</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skn0tt" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/presidentelect"><img src="https://avatars2.githubusercontent.com/u/1242300?v=4" width="60px;" alt=""/><br /><sub><b>Michael Hansen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=presidentelect" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://klickverbot.at/"><img src="https://avatars1.githubusercontent.com/u/19335?v=4" width="60px;" alt=""/><br /><sub><b>David Nadlinger</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dnadlinger" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://pluckd.co/"><img src="https://avatars2.githubusercontent.com/u/20598571?v=4" width="60px;" alt=""/><br /><sub><b>Fernando</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=MrCordeiro" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/jfgonzalez7"><img src="https://avatars3.githubusercontent.com/u/58857736?v=4" width="60px;" alt=""/><br /><sub><b>Juan Gonzalez</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jfgonzalez7" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.louiechristie.com/"><img src="https://avatars1.githubusercontent.com/u/6807448?v=4" width="60px;" alt=""/><br /><sub><b>Louie Christie</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=louiechristie" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4" width="60px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SuperSandro2000" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Skn0tt"><img src="https://avatars1.githubusercontent.com/u/14912729?v=4" width="60px;" alt=""/><br /><sub><b>Simon Knott</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skn0tt" title="Documentation">📖</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://styfle.dev/"><img src="https://avatars1.githubusercontent.com/u/229881?v=4?s=60" 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?s=60" 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?s=60" 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?s=60" 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://github.com/ayushbaweja"><img src="https://avatars1.githubusercontent.com/u/44344063?v=4?s=60" 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://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://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://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>
+    <td align="center"><a href="https://github.com/chirag-singhal"><img src="https://avatars3.githubusercontent.com/u/42653703?v=4" width="60px;" alt=""/><br /><sub><b>CHIRAG SINGHAL</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=chirag-singhal" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/lostintangent"><img src="https://avatars3.githubusercontent.com/u/116461?v=4" width="60px;" alt=""/><br /><sub><b>Jonathan Carter</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=lostintangent" title="Documentation">📖</a></td>
   </tr>
 </table>
 

docs/link-reference-definition-improvements.md

@@ -0,0 +1,142 @@
+# Link Reference Definition Improvements
+
+## Current Problems
+
+### File-by-file Insertion
+
+For the time being, if you want to get [[wiki-links]] into all files within the workspace, you'll need to generate the link reference definitions yourself file-by-file (with the assistance of Foam).
+
+### Wikilinks don't work on GitHub
+
+> **TL;DR;** [workaround](#workaround) in the end of the chapter.
+
+If you click any of the wiki-links on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
+
+At the time of writing (June 28 2020) this is a known, but unsolved error. To understand why this is the case, we need to understand what we are trading off.
+
+So, why don't they work on GitHub?
+
+The three components of [[link-reference-definitions]] are link label, link destination and Link Title.
+
+The issue is the middle **link destination** component. It's configured to point to the file name **without file extension**, i.e. "file-name" instead of "file-name.md". This is to make the GitHub Pages rendering work, because if we generated the links to `file-name.md`, the links would point to the raw markdown files instead of their generated HTML versions.
+
+| Environment      | `file-name` | `file-name.md` |
+| ---------------- | ----------- | -------------- |
+| **VS Code**      | Works       | Works          |
+| **GitHub pages** | Works       | Breaks         |
+| **GitHub UI**    | Breaks      | Works          |
+
+So as you can see, we've prioritised GitHub Pages over GitHub Web UI for the time being.
+
+Ideally, we'd like a solution that works with both, but it's not defined yet (see [[link-reference-definitions]] for more details)
+
+#### Workaround
+
+For the time being, you can use relative `[markdown links](markdown-link.md)` syntax.
+
+**Pros:**
+
+- This will work on all platforms.
+
+**Cons:**
+
+- It will break the Markdown Notes [[backlinking]] support
+- Less convenient to write
+
+### Finding certain words clutter the VS Code search results
+
+Since link reference definitions have `[//begin]` and `[//end]` guards with explanatory text that use certain words, these words (like "generate") appear in VS Code search results if you happen to search matching strings from the workspace.
+
+## Improvement Proposal
+
+Problem space in essence:
+
+- During edit-time (when modifying the markdown files in an editor)
+  - link reference definitions are needed if user uses editor extensions that don't understand wikilinks
+  - link reference definitions may be annoying since they 
+    - add content to files that the user hasn't typed in by themselves
+    - get out of date if user uses a tool that doesn't autogenerate them
+    - may clutter the search results
+- During build-time (when converting markdown to html for publishing purposes)
+  - link reference definitions are needed, if the files are published via such tools (or to such platforms) that don't understand wikilinks
+  - link reference definitions might have to be in different formats depending on the publish target (e.g. Github pages vs Github UI)
+
+The potential solution:
+
+- For edit-time
+  - Make edit-time link reference definition generation optional via user settings. They should be on by default, and generating valid markdown links with a relative path to a `.md` file.
+  - Make format of the link reference definition configurable (whether to include '.md' or not)
+  - Out of recommended extensions, currently only "markdown links" doesn't support them (?). However even its [code](https://github.com/tchayen/markdown-links/blob/master/src/parsing.ts#L25) seems to include wikilink parser, so it might just be a bug?
+- For build-time
+  - To satisfy mutually incompatible constraints between GitHub UI, VSCode UI, and GitHub Pages, we should add a pre-processing/build step for pushing to GitHub Pages. 
+    - This would be a GitHub action (or a local script, ran via foam-cli) that outputs publish-friendly markdown format for static site generators and other publishing tools
+    - This build step should be pluggable, so that other transformations could be ran during it
+  - Have publish targets defined in settings, that support both turning the link reference definitions on/off and defining their format (.md or not). Example draft (including also edit-time aspect):
+    ```typescript
+    // settings json
+    // see enumerations below for explanations on values
+    {
+      "foam": {
+        "publish": [
+          {
+            "name": "Gitlab Mirror",     // name of the publish target
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "withExtensions"
+          },
+          {
+            "name": "GitHub Pages",
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "withoutExtensions"
+          },
+          {
+            "name": "Blog",
+            "linkTranspilation": "Off",
+            "linkReferenceDefinitions": "Off"
+          },
+          {
+            "name": "My Amazing PDF book",
+            "linkTranspilation": "WikiLinksToMarkdown"
+          }
+        ],
+        "edit": {
+          "linkReferenceDefinitions": "Off"
+        }
+      }
+    }
+
+    // Defines if and how links in markdown files are somehow converted (in-place) during build time
+    // Note that this enumeration is not valid edit-time, since we (probably) don't want to change text like this while user is editing it
+    enum LinkTranspilation {
+      Off,                   // links are not transpiled
+      WikiLinksToMarkdown,   // links using wiki-format [[link]] are converted to normal md links: [link](./some/file.md)
+                             // if this is set, not link reference definitions are generated (not needed)
+    }
+    
+    // Defines if and how link reference definition section is generated
+    enum LinkReferenceDefinitions {
+      Off,               // link reference definitions are not generated
+      WithExtensions,    // link reference definitions contain .md (or similar) file extensions
+      WithoutExtensions  // link reference definitions do not contain file extenions
+    }
+
+    ```
+  - With Foam repo, just use edit-time link reference definitions with '.md' extension - this makes the links work in the Github UI
+  - Have publish target defined for Github pages, that doesn't use '.md' extension, but still has the link reference definitions. Generate the output into gh-pages branch (or separate repo) with automation.
+    - This naturally requires first removing the existing link reference definitions during the build
+- Other
+  - To clean up the search results, remove link reference definition section guards (assuming that these are not defined by the markdown spec). Use unifiedjs parse trees to identify if there's missing (or surplus) definitions (check if they are identified properly by the library), and just add the needed definitions to the bottom of the file (without guards) AND remove them if they are not needed (anywhere from the file).
+
+Note that the proposal above supports both (build-time) inline transpilation of wikilinks as well as creation reference definitions. Depending on the direction of Foam, also only one of them could be selected. In that case the other could be implemented at later point of time.
+
+UI-wise, the publish targets could be picked in some similar fashion as the run/debug targets in vscode by implementing a separate panel, or maybe through command execution (CTRL+SHIFT+P) - not yet defined at this point.
+
+## Links
+
+- [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[wiki-links]: wiki-links "Wiki Links"
+[roadmap]: roadmap "Roadmap"
+[link-reference-definitions]: link-reference-definitions "Link Reference Definitions"
+[backlinking]: backlinking "Backlinking"
+[//end]: # "Autogenerated link references"

docs/link-reference-definitions.md

@@ -0,0 +1,37 @@
+# Link Reference Definitions
+
+## Introduction
+
+When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension will automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wiki-links]]`.
+
+## Example
+
+The following example:
+  ```md
+  - [[wiki-links]]
+  - [[github-pages]]
+  ```
+...generates the following link reference definitions to the bottom of the file:
+  ```md
+  [wiki-links]: wiki-links "Wiki Links"
+  [github-pages]: github-pages "Github Pages"
+  ```
+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
+
+## Specification
+
+The three components of a link reference definition are `[link-label]: link-target "Link Title"`
+
+- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wiki-link]]` notation
+- **link destination** The target of the matched link
+  - Right now we generate link destinations without file extension. This is a choice, see [discussion here](https://foambubble.github.io/foam/wiki-links#why-dont-wiki-links-work-on-github).
+- **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime)
+
+See [[link-reference-definition-improvements]] for further discussion on current problems and potential solutions.
+
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[wiki-links]: wiki-links "Wiki Links"
+[roadmap]: roadmap "Roadmap"
+[link-reference-definition-improvements]: link-reference-definition-improvements "Link Reference Definition Improvements"
+[//end]: # "Autogenerated link references"

docs/math-support.md

@@ -0,0 +1,36 @@
+---
+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`:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
+<script type="text/x-mathjax-config">
+    MathJax.Hub.Config({
+        tex2jax: {
+            skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
+            inlineMath: [['$','$']]
+        }
+    });
+</script>
+```
+
+Example of inline math: $e^{i \pi}+1=0$  
+Example of displayed math:  
+
+$$ 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}|}} $$  
+
+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`:
+
+```
+---
+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)

docs/recipes.md

@@ -14,7 +14,7 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 - [Workflow](#workflow)
 - [Creative ideas](#creative-ideas)
 - [Other](#other)
-  
+
 ## Contribute
 
 - Start by reading [[contribution-guide]]
@@ -23,7 +23,7 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 ## Take smart notes
 
 - Introduction to Zettelkasten [[todo]]
-  
+
 ## Discover
 - Explore your notes using [[graph-visualisation]]
 - Discover relationships with [[backlinking]]
@@ -31,15 +31,16 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 
 ## Organise
 - Using [[backlinking]] for [[reference-lists]].
-  
+
 ## Write
 - Link documents with [[wiki-links]]
 - Use shortcuts for [[creating-new-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]]
 - [Markdown All-in-One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) features [[todo]] [[good-first-task]]
-  - Manage checklists 
+  - Manage checklists
   - Automatic Table of Contents
   - Live preview markdown
   - _More..._
@@ -48,30 +49,31 @@ Guides, tips and strategies for getting the most out of your Foam workspace!
 
 ## Version control
 
-- Quick commits with [[git-integration]]
+- Quick commits with VS Code's built in [[git-integration]]
+- Store your workspace in an auto-synced GitHub repo with [[gistpad]]
 - Sync your GitHub repo automatically [[todo]].
 
 ## Publish
 
 - Publish to [[github-pages]]
+- Publish to [[gitlab-pages]]
+- Publish your site with [[eleventy-and-netlify]]
 - Make the site your own by [[customising-styles]].
-- Host your own website [[todo]]
+- Math support [[math-support]]
 
 ## Collaborate
 
 - Give your team push access to your GitHub repo [[todo]]
 - Real-time collaboration via VS Code Live Share [[todo]]
 - Accept patches via GitHub PRs [[todo]]
- 
+
 ## Workflow
 
-Workflow recipes wanted!
-
-_See [[contribution-guide]] and [[how-to-write-recipes]]._
+- Capture notes from Drafts app on iOS [[capture-notes-with-drafts-pro]]
 
 ## Creative ideas
 
-Creative ideas welcome! 
+Creative ideas welcome!
 
 - Support [Anki](https://apps.ankiweb.net/) cards from notes like [Remnote](https://www.remnote.io/) [[todo]]
 
@@ -79,7 +81,7 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._
 
 ## Other
 
-Thought of a recipe but don't see a category for them? Add them here and we'll organise them once we detect a theme. 
+Thought of a recipe but don't see a category for them? Add them here and we'll organise them once we detect a theme.
 
 _See [[contribution-guide]] and [[how-to-write-recipes]]._
 
@@ -96,8 +98,14 @@ _See [[contribution-guide]] and [[how-to-write-recipes]]._
 [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"
 [github-pages]: github-pages "Github Pages"
+[gitlab-pages]: gitlab-pages "GitLab Pages"
+[eleventy-and-netlify]: eleventy-and-netlify "Eleventy and Netlify"
 [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"
+[gistpad]: gistpad "GistPad"
 [//end]: # "Autogenerated link references"

docs/roadmap.md

@@ -42,6 +42,8 @@ If a roadmap item is a stub, **consider** opening a [GitHub issue](https://githu
 - [[materialized-backlinks]]
 - [[automatic-git-syncing]]
 - [[git-flows-for-teams]]
+- [[user-settings]]
+- [[link-reference-definitions]]
 
 ### Publishing
 

docs/terminology.md

@@ -4,20 +4,17 @@ It would be good to have some shared terminology to talk about Foam concepts. So
 
 Here's some ideas, these are open for discussion.
 
-## Foam (project)
+## Foam, the software project
 
 The set of tools and ideas collected in this organisation.
 
-## Foam workspace
+## (Your) Foam
 
-The directory/repository where you keep all your documents.
+The directory/repository where you keep all your notes.
+
+Also happens to sound quite a lot like Home. Funny, that.
 
 ## Bubble
 
-Individual Foam document, written in Markdown.
+Individual Foam note, written in Markdown.
 
-## Foam blog
-
-When you use Foam to publish content to an audience.
-
-_Better ideas welcome._

docs/user-settings.md

@@ -0,0 +1,9 @@
+# User Settings (stub)
+
+**[[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"

docs/wiki-links.md

@@ -1,6 +1,6 @@
 # Wiki Links
 
-Foam enables you to Link pages together using `[[file-name]]` annotations.
+Foam enables you to Link pages together using `[[file-name]]` annotations (i.e. `[[media-wiki]]` links).
 
 - Both `[[file-name]]` and `[[file-name.md]]` work
 - Type `[[` and start typing a file name for autocompletion.
@@ -9,6 +9,49 @@ Foam enables you to Link pages together using `[[file-name]]` annotations.
 
 > If the `F12` shortcut feels unnatural you can rebind it at File > Preferences > Keyboard Shortcuts by searching for `editor.action.revealDefinition`.
 
+## Filenaming Specification
+
+Foam is designed to be flexible to your workflow. As a result it will try to do th best thing when you link to documents.
+
+For example:
+
+If there was only one file in the solution called `first-file.md`, and you added the following markdown:
+
+```markdown
+Here is a link to [[another file]]
+```
+
+You now have a link to a file that doesn't exist. If you `ctrl-click` the link it wil automatically generate `another-file.md`.
+
+Now you edit the first file more and amend the line ...
+
+```markdown
+Here is a link to [[another file]] and [[Another File]]
+```
+Foam decides that loosley matched files also count, so it will assume you meant `another-file.md` was the correct file to match.
+
+However there are instances that the user may want separate versions of the same file with captialisation differences. This being a special case has to be opted in by manually creating a file `Another File.md`. Foam will know that there is a more specific version of the file, and match that instead of loosley matching.
+
+The logic is as follows...
+
+``` Markdown
+[[New File]]
+```
+
+View the proposed flow [here](https://mermaid-js.github.io/mermaid-live-editor/#/view/eyJjb2RlIjoiZ3JhcGggVERcbiAgaWQxKFtgTmV3IEZpbGUubWRgIGV4aXN0cyBpbiB0aGlzIGRpcmVjdG9yeT9dKSAtLT4gZXhpdDEoVXNlIGBOZXcgRmlsZS5tZGApXG4gIGlkMihbYG5ldy1maWxlLm1kYCBleGlzdHMgaW4gdGhpcyBkaXJlY3Rvcnk_XSkgLS0-IGV4aXQyKFVzZSBgbmV3LWZpbGUubWRgKVxuICBpZDMoW0FueSBmaWxlIHRoYXQgbWF0Y2hlcyBgbmV3LWZpbGUubWRgIGFmdGVyIGJlaW5nIHNsdWdpZmllZCBpbiB0aGlzIGRpcmVjdG9yeT9dKSAtLT4gZXhpdDMoVXNlIHRoZSB1bnNsdWdnZWQgZmlsZSlcbiAgaWQ0KFtgTmV3IEZpbGUubWRgIGV4aXN0cyBpbiB0aGUgcm9vdCBkaXJlY3Rvcnk_XSkgLS0-IGV4aXQ0KFVzZSBgTmV3IEZpbGUubWRgIGluIHRoZSByb290KVxuICBpZDUoW2BuZXctZmlsZS5tZGAgZXhpc3RzIGluIHRoZSByb290IGRpcmVjdG9yeT9dKSAtLT4gZXhpdDUoVXNlIGBuZXctZmlsZS5tZGAgaW4gdGhlIHJvb3QpXG4gIGlkNihbQW55IGZpbGUgdGhhdCBtYXRjaGVzIGBuZXctZmlsZS5tZGAgYWZ0ZXIgYmVpbmcgc2x1Z2lmaWVkIGluIHRoaXMgZGlyZWN0b3J5P10pIC0tPiBleGl0NihVc2UgdGhlIHVuc2x1Z2dlZCBmaWxlIGluIHRoZSByb290KVxuICBleGl0NyhDcmVhdGUgYSBuZXcgZmlsZSBpbiB0aGUgY3VycmVudCBkaXJlY3RvcnR5IGNhbGxlZCBgTmV3IEZpbGUubWRgKVxuICBpZDEgLS0-IGlkMiAtLT4gaWQzIC0tPiBpZDQgLS0-IGlkNSAtLT4gaWQ2IC0tPiBleGl0NyIsIm1lcm1haWQiOnsidGhlbWUiOiJkZWZhdWx0In0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9)
+
+```mermaid
+graph TD
+  id1([`New File.md` exists in this directory?]) --> exit1(Use `New File.md`)
+  id2([`new-file.md` exists in this directory?]) --> exit2(Use `new-file.md`)
+  id3([Any file that matches `new-file.md` after being slugified in this directory?]) --> exit3(Use the unslugged file)
+  id4([`New File.md` exists in the root directory?]) --> exit4(Use `New File.md` in the root)
+  id5([`new-file.md` exists in the root directory?]) --> exit5(Use `new-file.md` in the root)
+  id6([Any file that matches `new-file.md` after being slugified in this directory?]) --> exit6(Use the unslugged file in the root)
+  exit7(Create a new file in the current directorty called `New File.md`)
+  id1 --> id2 --> id3 --> id4 --> id5 --> id6 --> exit7
+```
+
 ## Required extensions
 
  - [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) (core functionality)
@@ -16,72 +59,15 @@ Foam enables you to Link pages together using `[[file-name]]` annotations.
 
 ## Markdown compatibility
 
-The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [markdown link reference definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file to make wiki-links compatible with Markdown tools and parsers.
-
-If you look at link references the bottom of any Foam workspace file that uses wiki-links, you should see an automatically generated list of references that look as follows:
-
-```markdown
-[wiki-links]: wiki-links "Wiki Links"
-[other-page]: other-page "Other Page"
-```
-
-These exist to make `[[wiki-links]]` compatible with Markdown-consuming tools such as static site generators, VS Code plugins etc. 
-
-## Why don't `[[wiki-links]]` work on GitHub
-
-> **TL;DR;** [workaround](#workaround) in the end.
-
-If you click any of the wiki-links on GitHub web UI (such as the `README.md` of a project), you'll notice that the links break with a 404 error.
-
-At the time of writing (June 28 2020) this is a known, but unsolved error. To understand why this is the case, we need to understand what we are trading off.
-
-So, why don't they work on GitHub?
-
-The three components of a [link reference definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) are:
-
-- **link label:** The link text to match in the surrounding markdown document. This matches the inner bracket of the double-bracketed `[[wiki-link]]` notation
-- **link destination** The target of the matched link
-- **"Link Title"** Optional title for link (The Foam template has a snippet of JavaScript to replace this on the website at runtime)
-
-The issue is the middle **link destination** component. It's configured to point to the file name **without file extension**, i.e. "file-name" instead of "file-name.md". This is to make the GitHub Pages rendering work, because if we generated the links to `file-name.md`, the links would point to the raw markdown files instead of their generated HTML versions.
-
-| Environment      | `file-name` | `file-name.md` |
-| ---------------- | ----------- | -------------- |
-| **VS Code**      | Works       | Works          |
-| **GitHub pages** | Works       | Breaks         |
-| **GitHub UI**    | Breaks      | Works          |
-
-So as you can see, we've prioritised GitHub Pages over GitHub Web U for the time being.
-
-Ideally, we'd like a solution that works with both, but I haven't thought of it yet. Ideas include:
-
-- **Writing a better static side generator that works with `file-name.md` link targets.** This is on the [[roadmap]], but for the time being GitHub Pages support is as must-have.
-- **Adding a configuration setting to generate `file-name.md` link targets.** This is fine and I would accept this contribution to [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode), but it doesn't solve the core problem.
-
-An acceptable solution may include one where we don't generate link reference definitions at all, but if we do, ideally, we'd like to generate `file-name.md` links since those are more standards compatible for different markdown tools.
-
-I'm sure there's an elegant-ish solution out there. Ideas and suggestions welcome that the [tracking issue on GitHub](https://github.com/foambubble/foam/issues/16)
-
-### Workaround
-
-For the time being, you can use relative `[markdown links](markdown-link.md)` syntax.
-
-**Pros:**
-
-- This will work on all platforms.
-
-**Cons:**
-
-- It will break the Markdown Notes [[backlinking]] support
-- Less convenient to write
+The [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) extension automatically generates [[link-reference-definitions]] at the bottom of the file to make wiki-links compatible with Markdown tools and parsers.
 
 ## Read more
 
 - [[foam-file-format]]
+- See [[link-reference-definition-improvements]] for further discussion on current problems and potential solutions.
 
 [//begin]: # "Autogenerated link references for markdown compatibility"
-[wiki-links]: wiki-links "Wiki Links"
-[roadmap]: roadmap "Roadmap"
-[backlinking]: backlinking "Backlinking"
+[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"
 [//end]: # "Autogenerated link references"

package.json

@@ -10,7 +10,10 @@
     "packages/*"
   ],
   "scripts": {
-    "watch": "yarn workspace foam-vscode watch"
+    "watch:vscode": "yarn workspace foam-vscode watch",
+    "build:core": "yarn workspace foam-core build",
+    "watch:core": "yarn workspace foam-core start",
+    "test:core": "yarn workspace foam-core test"
   },
   "devDependencies": {
     "all-contributors-cli": "^6.16.1",
@@ -30,4 +33,4 @@
     "singleQuote": true,
     "trailingComma": "es5"
   }
-}
+}

packages/foam-cli/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', {targets: {node: 'current'}}],
+   '@babel/preset-typescript',
+  ],
+};

packages/foam-cli/jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/p6/5y5l8tbs1d32pq9b596lk48h0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

packages/foam-cli/package.json

@@ -11,17 +11,25 @@
     "@oclif/command": "^1",
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^3",
+    "foam-core": "^0.2.0",
+    "ora": "^4.0.4",
     "tslib": "^1"
   },
   "devDependencies": {
+    "@babel/core": "^7.10.4",
+    "@babel/preset-env": "^7.10.4",
+    "@babel/preset-typescript": "^7.10.4",
     "@oclif/dev-cli": "^1",
     "@types/node": "^10",
+    "babel-jest": "^26.1.0",
     "chai": "^4",
     "eslint": "^5.13",
     "eslint-config-oclif": "^3.1",
     "eslint-config-oclif-typescript": "^0.1",
     "foam-core": "^0.2.0",
     "globby": "^10",
+    "jest": "^26.1.0",
+    "mock-fs": "^4.12.0",
     "ts-node": "^8",
     "typescript": "^3.3"
   },
@@ -54,10 +62,9 @@
   "scripts": {
     "cli": "./bin/run",
     "postpack": "rm -f oclif.manifest.json",
-    "posttest": "eslint . --ext .ts --config .eslintrc",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "jest",
     "version": "oclif-dev readme && git add README.md"
   },
   "types": "lib/index.d.ts"
-}
+}

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

@@ -0,0 +1,77 @@
+import { Command, flags } from '@oclif/command';
+import * as ora from 'ora';
+import {
+  initializeNoteGraph,
+  generateLinkReferences,
+  generateHeading,
+  getKebabCaseFileName,
+} from 'foam-core';
+import { applyTextEdit } from '../utils/apply-text-edit';
+import { writeFileToDisk } from '../utils/write-file-to-disk';
+import { isValidDirectory } from '../utils';
+
+export default class Janitor extends Command {
+  static description =
+    'Updates link references and heading across all the markdown files in the given workspaces';
+
+  static examples = [
+    `$ foam-cli janitor path-to-foam-workspace
+Successfully generated link references and heading!
+`,
+  ];
+
+  static flags = {
+    help: flags.help({ char: 'h' }),
+  };
+
+  static args = [{ name: 'workspacePath' }];
+
+  async run() {
+    const spinner = ora('Reading Files').start();
+
+    const { args, flags } = this.parse(Janitor);
+
+    const { workspacePath = './' } = args;
+
+    if (isValidDirectory(workspacePath)) {
+      const graph = await initializeNoteGraph(workspacePath);
+
+      const notes = graph.getNotes().filter(Boolean); // removes undefined notes
+
+      spinner.succeed();
+      spinner.text = `${notes.length} files found`;
+      spinner.succeed();
+
+      // exit early if no files found.
+      if (notes.length === 0) {
+        this.exit();
+      }
+
+      spinner.text = 'Generating link definitions';
+
+      const fileWritePromises = notes.map(note => {
+        // Get edits
+        const heading = generateHeading(note);
+        const definitions = generateLinkReferences(note, graph);
+
+        // apply Edits
+        let file = note.source;
+        file = heading ? applyTextEdit(file, heading) : file;
+        file = definitions ? applyTextEdit(file, definitions) : file;
+
+        if (heading || definitions) {
+          return writeFileToDisk(note.path, file);
+        }
+
+        return Promise.resolve(null);
+      });
+
+      await Promise.all(fileWritePromises);
+
+      spinner.succeed();
+      spinner.succeed('Done!');
+    } else {
+      spinner.fail('Directory does not exist!');
+    }
+  }
+}

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

@@ -0,0 +1,100 @@
+import { Command, flags } from '@oclif/command';
+import * as ora from 'ora';
+import {
+  initializeNoteGraph,
+  generateLinkReferences,
+  generateHeading,
+  getKebabCaseFileName,
+} from 'foam-core';
+import { applyTextEdit } from '../utils/apply-text-edit';
+import { writeFileToDisk } from '../utils/write-file-to-disk';
+import { renameFile } from '../utils/rename-file';
+import { isValidDirectory } from '../utils';
+
+// @todo: Refactor 'migrate' and 'janitor' commands and avoid repeatition
+export default class Migrate extends Command {
+  static description =
+    'Updates file names, link references and heading across all the markdown files in the given workspaces';
+
+  static examples = [
+    `$ foam-cli migrate path-to-foam-workspace
+Successfully generated link references and heading!
+`,
+  ];
+
+  static flags = {
+    help: flags.help({ char: 'h' }),
+  };
+
+  static args = [{ name: 'workspacePath' }];
+
+  async run() {
+    const spinner = ora('Reading Files').start();
+
+    const { args, flags } = this.parse(Migrate);
+
+    const { workspacePath = './' } = args;
+
+    if (isValidDirectory(workspacePath)) {
+      let graph = await initializeNoteGraph(workspacePath);
+
+      let notes = graph.getNotes().filter(Boolean); // removes undefined notes
+
+      spinner.succeed();
+      spinner.text = `${notes.length} files found`;
+      spinner.succeed();
+
+      // exit early if no files found.
+      if (notes.length === 0) {
+        this.exit();
+      }
+
+      // Kebab case file names
+      const fileRename = notes.map(note => {
+        const kebabCasedFileName = getKebabCaseFileName(note.title);
+        if (kebabCasedFileName) {
+          return renameFile(note.path, kebabCasedFileName);
+        }
+        return Promise.resolve(null);
+      });
+
+      await Promise.all(fileRename);
+
+      spinner.text = 'Renaming files';
+
+      // Reinitialize the graph after renaming files
+      graph = await initializeNoteGraph(workspacePath);
+
+      notes = graph.getNotes().filter(Boolean); // remove undefined notes
+
+      spinner.succeed();
+      spinner.text = 'Generating link definitions';
+
+      const fileWritePromises = await Promise.all(
+        notes.map(note => {
+          // Get edits
+          const heading = generateHeading(note);
+          const definitions = generateLinkReferences(note, graph);
+
+          // apply Edits
+          let file = note.source;
+          file = heading ? applyTextEdit(file, heading) : file;
+          file = definitions ? applyTextEdit(file, definitions) : file;
+
+          if (heading || definitions) {
+            return writeFileToDisk(note.path, file);
+          }
+
+          return Promise.resolve(null);
+        })
+      );
+
+      await Promise.all(fileWritePromises);
+
+      spinner.succeed();
+      spinner.succeed('Done!');
+    } else {
+      spinner.fail('Directory does not exist!');
+    }
+  }
+}

packages/foam-cli/src/utils/apply-text-edit.ts

@@ -0,0 +1,18 @@
+import { TextEdit } from 'foam-core';
+
+/**
+ *
+ * @param text text on which the textEdit will be applied
+ * @param textEdit
+ * @returns {string} text with the applied textEdit
+ */
+export const applyTextEdit = (text: string, textEdit: TextEdit): string => {
+  const characters = text.split('');
+  const startOffset = textEdit.range.start.offset || 0;
+  const endOffset = textEdit.range.end.offset || 0;
+  const deleteCount = endOffset - startOffset;
+
+  const textToAppend = `${textEdit.newText}`;
+  characters.splice(startOffset, deleteCount, textToAppend);
+  return characters.join('');
+};

packages/foam-cli/src/utils/index.ts

@@ -0,0 +1,4 @@
+import * as fs from 'fs';
+
+export const isValidDirectory = (path: string) =>
+  fs.existsSync(path) && fs.lstatSync(path).isDirectory();

packages/foam-cli/src/utils/rename-file.ts

@@ -0,0 +1,15 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+/**
+ *
+ * @param fileUri absolute path for the file that needs to renamed
+ * @param newFileName  "new file name" without the extension
+ */
+export const renameFile = async (fileUri: string, newFileName: string) => {
+  const dirName = path.dirname(fileUri);
+  const extension = path.extname(fileUri);
+  const newFileUri = path.join(dirName, `${newFileName}${extension}`);
+
+  return fs.promises.rename(fileUri, newFileUri);
+};

packages/foam-cli/src/utils/write-file-to-disk.ts

@@ -0,0 +1,5 @@
+import * as fs from 'fs';
+
+export const writeFileToDisk = async (fileUri: string, data: string) => {
+  return fs.promises.writeFile(fileUri, data);
+};

packages/foam-cli/test/apply-text-edit.test.ts

@@ -0,0 +1,81 @@
+import { applyTextEdit } from '../src/utils/apply-text-edit';
+
+describe('applyTextEdit', () => {
+  it('should return text with applied TextEdit in the end of the string', () => {
+    const textEdit = {
+      newText: `\n    4. this is fourth line`,
+      range: {
+        start: { line: 3, column: 1, offset: 79 },
+        end: { line: 3, column: 1, offset: 79 },
+      },
+    };
+
+    const text = `
+    1. this is first line
+    2. this is second line
+    3. this is third line
+    `;
+
+    const expected = `
+    1. this is first line
+    2. this is second line
+    3. this is third line
+    4. this is fourth line
+    `;
+
+    const actual = applyTextEdit(text, textEdit);
+
+    expect(actual).toBe(expected);
+  });
+
+  it('should return text with applied TextEdit at the top of the string', () => {
+    const textEdit = {
+      newText: `\n    1. this is first line`,
+      range: {
+        start: { line: 0, column: 0, offset: 0 },
+        end: { line: 0, column: 0, offset: 0 },
+      },
+    };
+
+    const text = `
+    2. this is second line
+    3. this is third line
+    `;
+
+    const expected = `
+    1. this is first line
+    2. this is second line
+    3. this is third line
+    `;
+
+    const actual = applyTextEdit(text, textEdit);
+
+    expect(actual).toBe(expected);
+  });
+
+  it('should return text with applied TextEdit in the middle of the string', () => {
+    const textEdit = {
+      newText: `\n    2. this is the updated second line`,
+      range: {
+        start: { line: 0, column: 0, offset: 26 },
+        end: { line: 0, column: 0, offset: 53 },
+      },
+    };
+
+    const text = `
+    1. this is first line
+    2. this is second line
+    3. this is third line
+    `;
+
+    const expected = `
+    1. this is first line
+    2. this is the updated second line
+    3. this is third line
+    `;
+
+    const actual = applyTextEdit(text, textEdit);
+
+    expect(actual).toBe(expected);
+  });
+});

packages/foam-cli/test/rename-file.test.ts

@@ -0,0 +1,30 @@
+import { renameFile } from '../src/utils/rename-file';
+import * as fs from 'fs';
+import mockFS from 'mock-fs';
+
+const doesFileExist = path =>
+  fs.promises
+    .access(path)
+    .then(() => true)
+    .catch(() => false);
+
+describe('renameFile', () => {
+  const fileUri = './test/oldFileName.md';
+
+  beforeAll(() => {
+    mockFS({ [fileUri]: '' });
+  });
+
+  afterAll(() => {
+    mockFS.restore();
+  });
+
+  it('should rename existing file', async () => {
+    expect(await doesFileExist(fileUri)).toBe(true);
+
+    renameFile(fileUri, 'new-file-name');
+
+    expect(await doesFileExist(fileUri)).toBe(false);
+    expect(await doesFileExist('./test/new-file-name.md')).toBe(true);
+  });
+});

packages/foam-cli/test/write-file-to-disk.test.ts

@@ -0,0 +1,23 @@
+import { writeFileToDisk } from '../src/utils/write-file-to-disk';
+import * as fs from 'fs';
+import mockFS from 'mock-fs';
+
+describe('writeFileToDisk', () => {
+  const fileUri = './test-file.md';
+
+  beforeAll(() => {
+    mockFS({ [fileUri]: 'content in the existing file' });
+  });
+
+  afterAll(() => {
+    fs.unlinkSync(fileUri);
+    mockFS.restore();
+  });
+
+  it('should overrwrite existing file in the disk with the new data', async () => {
+    const expected = `content in the new file`;
+    await writeFileToDisk(fileUri, expected);
+    const actual = await fs.promises.readFile(fileUri, { encoding: 'utf8' });
+    expect(actual).toBe(expected);
+  });
+});

packages/foam-core/package.json

@@ -15,6 +15,7 @@
     "prepare": "tsdx build"
   },
   "devDependencies": {
+    "@types/github-slugger": "^1.3.0",
     "@types/graphlib": "^2.1.6",
     "@types/lodash": "^4.14.157",
     "husky": "^4.2.5",
@@ -23,10 +24,14 @@
     "typescript": "^3.9.5"
   },
   "dependencies": {
+    "detect-newline": "^3.1.0",
+    "github-slugger": "^1.3.0",
+    "glob": "^7.1.6",
     "graphlib": "^2.1.8",
-    "lodash": "^4.17.15",
+    "lodash": "^4.17.19",
     "remark-parse": "^8.0.2",
     "remark-wiki-link": "^0.0.4",
+    "title-case": "^3.0.2",
     "unified": "^9.0.0",
     "unist-util-visit": "^2.0.2"
   },

packages/foam-core/src/LooseLinkReference.ts

@@ -0,0 +1,43 @@
+import { ID } from './note-graph';
+
+export interface ILooseLinkReference {
+    /**
+     * Base name of the file without extension, e.g. `Zoë File`
+     */
+    original: ID;
+    /**
+     * Cleaned version of the file, removing accents, casing, slugs, e.g. `zoe-file`
+     */
+    clean: string;
+}
+
+export interface IMatchResult extends ILooseLinkReference {
+    title: string;
+}
+
+export class LooseLinkReference implements ILooseLinkReference {
+  original: ID;
+  clean: string;
+  constructor(original: string) {
+    this.original = original;
+    this.clean = LooseLinkReference.cleanPath(original);
+  }
+  public static cleanPath(path: string): string {
+    const slug = '-'; //perhaps a config would be a better choice;
+    return path
+      .normalize("NFD").replace(/[\u0300-\u036f]/g, "") //Remove accents
+      .replace(/[!"\#$%&'()*+,\-./:;<=>?@\[\\\]^_‘{|}~\s]+/gi, slug) //Normalise slugs
+      .toLowerCase() // lower
+      .replace(/[-_－＿ ]*$/g, ''); // removing trailing slug chars
+  }
+  public static findBestMatchIndex(arrFiles: Array<ILooseLinkReference>, file: ILooseLinkReference): number {
+    let index = arrFiles.findIndex(v => v.original === file.original);
+    if (index === -1) {
+      index = arrFiles.findIndex(v => v.clean === file.clean);
+    }
+    return index;
+  }
+  public static findBestMatch(arrFiles: Array<ILooseLinkReference>, file: ILooseLinkReference): ILooseLinkReference {
+    return arrFiles[LooseLinkReference.findBestMatchIndex(arrFiles, file)];
+  }
+}

packages/foam-core/src/index.ts

@@ -1,5 +1,32 @@
-export { NoteGraph, Note, NoteLink } from './note-graph';
+import { NoteGraph, Note, NoteLink } from './note-graph';
+
 export {
   createNoteFromMarkdown,
   createMarkdownReferences,
+  stringifyMarkdownLinkReferenceDefinition,
 } from './markdown-provider';
+
+export {
+  TextEdit,
+  generateHeading,
+  generateLinkReferences,
+  getKebabCaseFileName,
+} from './janitor';
+
+export { initializeNoteGraph } from './initialize-note-graph';
+
+export { NoteGraph, Note, NoteLink };
+
+export interface FoamConfig {
+  // TODO
+}
+
+export interface Foam {
+  notes: NoteGraph;
+  // config: FoamConfig
+}
+
+export const createFoam = (config: FoamConfig) => ({
+  notes: new NoteGraph(),
+  config: config,
+});

packages/foam-core/src/initialize-note-graph.ts

@@ -0,0 +1,30 @@
+import glob from 'glob';
+import { promisify } from 'util';
+import fs from 'fs';
+import os from 'os';
+import detectNewline from 'detect-newline';
+import { NoteGraph } from './note-graph';
+import { createNoteFromMarkdown } from './markdown-provider';
+
+const findAllFiles = promisify(glob);
+
+export const initializeNoteGraph = async (workspacePath: string) => {
+  // remove trailing slash from workspacePath if exists
+  if (workspacePath.substr(-1) === '/')
+    workspacePath = workspacePath.slice(0, -1);
+
+  const files = await findAllFiles(`${workspacePath}/**/*.md`, {});
+
+  const graph = new NoteGraph();
+  await Promise.all(
+    (await files).map(f => {
+      return fs.promises.readFile(f).then(data => {
+        const markdown = (data || '').toString();
+        const eol = detectNewline(markdown) || os.EOL;
+        graph.setNote(createNoteFromMarkdown(f, markdown, eol));
+      });
+    })
+  );
+
+  return graph;
+};

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

@@ -0,0 +1,98 @@
+import { Position } from 'unist';
+import GithubSlugger from 'github-slugger';
+import { Note, NoteGraph } from '../index';
+import {
+  createMarkdownReferences,
+  stringifyMarkdownLinkReferenceDefinition,
+} from '../markdown-provider';
+import { getHeadingFromFileName } from '../utils';
+
+const slugger = new GithubSlugger();
+
+const INCLUDE_EXTENSION__HARD_CODED_READ_FROM_PROJECT_SETTINGS_FILE = false;
+
+export interface TextEdit {
+  range: Position;
+  newText: string;
+}
+
+export const generateLinkReferences = (
+  note: Note,
+  ng: NoteGraph
+): TextEdit | null => {
+  if (!note) {
+    return null;
+  }
+
+  const newReferences = createMarkdownReferences(
+    ng,
+    note.id,
+    INCLUDE_EXTENSION__HARD_CODED_READ_FROM_PROJECT_SETTINGS_FILE
+  )
+    .map(stringifyMarkdownLinkReferenceDefinition)
+    .join('\n');
+
+  if (note.definitions.length === 0) {
+    if (newReferences.length === 0) {
+      return null;
+    }
+
+    const padding = note.end.column === 1 ? note.eol : `${note.eol}${note.eol}`;
+    return {
+      newText: `${padding}${newReferences}`,
+      range: {
+        start: note.end,
+        end: note.end,
+      },
+    };
+  } else {
+    const first = note.definitions[0];
+    const last = note.definitions[note.definitions.length - 1];
+
+    const oldReferences = note.definitions
+      .map(stringifyMarkdownLinkReferenceDefinition)
+      .join(note.eol);
+
+    if (oldReferences === newReferences) {
+      return null;
+    }
+
+    return {
+      // @todo: do we need to ensure new lines?
+      newText: `${newReferences}`,
+      range: {
+        start: first.position!.start,
+        end: last.position!.end,
+      },
+    };
+  }
+};
+
+export const generateHeading = (note: Note): TextEdit | null => {
+  if (!note) {
+    return null;
+  }
+
+  if (note.title) {
+    return null;
+  }
+
+  return {
+    newText: `# ${getHeadingFromFileName(note.id)}${note.eol}${note.eol}`,
+    range: {
+      start: { line: 0, column: 0, offset: 0 },
+      end: { line: 0, column: 0, offset: 0 },
+    },
+  };
+};
+
+/**
+ *
+ * @param fileName
+ * @returns null if file name is already in kebab case otherise returns
+ * the kebab cased file name
+ */
+export const getKebabCaseFileName = (fileName: string) => {
+  const kebabCasedFileName = slugger.slug(fileName);
+  return kebabCasedFileName === fileName ? null : kebabCasedFileName;
+};

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

@@ -4,7 +4,7 @@ import wikiLinkPlugin from 'remark-wiki-link';
 import visit, { CONTINUE, EXIT } from 'unist-util-visit';
 import { Node, Parent } from 'unist';
 import * as path from 'path';
-import { Link, Note, NoteGraph } from './note-graph';
+import { Note, NoteLink, NoteLinkDefinition, NoteGraph } from './note-graph';
 import { dropExtension } from './utils';
 
 let processor: unified.Processor | null = null;
@@ -18,40 +18,62 @@ function parse(markdown: string): Node {
   return processor.parse(markdown);
 }
 
-export function createNoteFromMarkdown(uri: string, markdown: string): Note {
+export function createNoteFromMarkdown(
+  uri: string,
+  markdown: string,
+  eol: string
+): Note {
   const filename = path.basename(uri);
   const id = path.parse(filename).name;
   const tree = parse(markdown);
-  let title = id;
+  let title: string | null = null;
   visit(tree, node => {
     if (node.type === 'heading' && node.depth === 1) {
       title = ((node as Parent)!.children[0].value as string) || title;
     }
-    return title === id ? CONTINUE : EXIT;
+    return title === null ? CONTINUE : EXIT;
   });
-  const links: Link[] = [];
+  const links: NoteLink[] = [];
+  const definitions: NoteLinkDefinition[] = [];
   visit(tree, node => {
     if (node.type === 'wikiLink') {
       links.push({
-        from: id,
         to: node.value as string,
         text: node.value as string,
+        position: node.position!,
+      });
+    }
+
+    if (node.type === 'definition') {
+      definitions.push({
+        label: node.label as string,
+        url: node.url as string,
+        title: node.title as string,
+        position: node.position,
       });
     }
   });
-  return new Note(id, title, links, uri, markdown);
+
+  const end = tree.position!.end;
+
+  return new Note(id, title, links, definitions, end, uri, markdown, eol);
 }
 
-interface MarkdownReference {
-  linkText: string;
-  wikiLink: string;
-  pageTitle: string;
-}
+export function stringifyMarkdownLinkReferenceDefinition(
+  definition: NoteLinkDefinition
+) {
+  let text = `[${definition.label}]: ${definition.url}`;
+  if (definition.title) {
+    text = `${text} "${definition.title}"`;
+  }
 
+  return text;
+}
 export function createMarkdownReferences(
   graph: NoteGraph,
-  noteId: string
-): MarkdownReference[] {
+  noteId: string,
+  includeExtension: boolean
+): NoteLinkDefinition[] {
   const source = graph.getNote(noteId);
 
   // Should never occur since we're already in a file,
@@ -72,7 +94,7 @@ export function createMarkdownReferences(
       // but int the future we may want to surface these too
       if (!target) {
         console.log(
-          `Link '${link.to}' in '${noteId}' points to a non-existing note.`
+          `Warning: Link '${link.to}' in '${noteId}' points to a non-existing note.`
         );
         return null;
       }
@@ -81,15 +103,18 @@ export function createMarkdownReferences(
         path.dirname(source.path),
         target.path
       );
-      const relativePathWithoutExtension = dropExtension(relativePath);
 
-      // [wiki-link-text]: wiki-link "Page title"
+      const pathToNote = includeExtension
+        ? relativePath
+        : dropExtension(relativePath);
+
+      // [wiki-link-text]: path/to/file.md "Page title"
       return {
-        linkText: link.to,
-        wikiLink: relativePathWithoutExtension,
-        pageTitle: target.title,
+        label: link.text,
+        url: pathToNote,
+        title: target.title || target.id,
       };
     })
     .filter(Boolean)
-    .sort() as MarkdownReference[];
+    .sort() as NoteLinkDefinition[];
 }

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

@@ -1,6 +1,8 @@
 import { Graph, Edge } from 'graphlib';
+import { Position, Point } from 'unist';
+import GithubSlugger from 'github-slugger';
 
-type ID = string;
+export type ID = string;
 
 export interface Link {
   from: ID;
@@ -11,27 +13,44 @@ export interface Link {
 export interface NoteLink {
   to: ID;
   text: string;
+  position: Position;
+}
+
+export interface NoteLinkDefinition {
+  label: string;
+  url: string;
+  title?: string;
+  position?: Position;
 }
 
 export class Note {
   public id: ID;
-  public title: string;
+  public title: string | null;
   public source: string;
   public path: string;
+  public end: Point;
+  public eol: string;
   public links: NoteLink[];
+  public definitions: NoteLinkDefinition[];
 
   constructor(
     id: ID,
-    title: string,
+    title: string | null,
     links: NoteLink[],
+    definitions: NoteLinkDefinition[],
+    end: Point,
     path: string,
-    source: string
+    source: string,
+    eol: string
   ) {
     this.id = id;
     this.title = title;
     this.source = source;
     this.path = path;
     this.links = links;
+    this.definitions = definitions;
+    this.end = end;
+    this.eol = eol;
   }
 }
 
@@ -50,7 +69,8 @@ export class NoteGraph {
     }
     this.graph.setNode(note.id, note);
     note.links.forEach(link => {
-      this.graph.setEdge(note.id, link.to, link.text);
+      const slugger = new GithubSlugger();
+      this.graph.setEdge(note.id, slugger.slug(link.to), link.text);
     });
   }
 
@@ -67,25 +87,25 @@ export class NoteGraph {
 
   public getAllLinks(noteId: ID): Link[] {
     return (this.graph.nodeEdges(noteId) || []).map(edge =>
-      convertEdgeToLink(edge)
+      convertEdgeToLink(edge, this.graph)
     );
   }
 
   public getForwardLinks(noteId: ID): Link[] {
     return (this.graph.outEdges(noteId) || []).map(edge =>
-      convertEdgeToLink(edge)
+      convertEdgeToLink(edge, this.graph)
     );
   }
 
   public getBacklinks(noteId: ID): Link[] {
     return (this.graph.inEdges(noteId) || []).map(edge =>
-      convertEdgeToLink(edge)
+      convertEdgeToLink(edge, this.graph)
     );
   }
 }
 
-const convertEdgeToLink = (edge: Edge): Link => ({
+const convertEdgeToLink = (edge: Edge, graph: Graph): Link => ({
   from: edge.v,
   to: edge.w,
-  text: edge.name || edge.w,
+  text: graph.edge(edge.v, edge.w),
 });

packages/foam-core/src/utils.ts

@@ -1,5 +1,16 @@
+import { titleCase } from 'title-case';
+
 export function dropExtension(path: string): string {
   const parts = path.split('.');
   parts.pop();
   return parts.join('.');
 }
+
+/**
+ *
+ * @param filename
+ * @returns title cased heading after removing special characters
+ */
+export const getHeadingFromFileName = (filename: string): string => {
+  return titleCase(filename.replace(/[^\w\s]/gi, ' '));
+};

packages/foam-core/test/__migration__/Roam Document.md

@@ -0,0 +1,3 @@
+# Roam Document
+
+[[Second Roam Document]]

packages/foam-core/test/__migration__/Second Roam Document.md

@@ -0,0 +1 @@
+# Second Roam Document

packages/foam-core/test/__scaffold__/file-without-title.md

@@ -0,0 +1 @@
+This file is missing a title

packages/foam-core/test/__scaffold__/first-document.md

@@ -0,0 +1,7 @@
+# First Document
+
+[[file-without-title]]
+
+[//begin]: # 'Autogenerated link references for markdown compatibility'
+[second-document]: second-document 'Second Document'
+[//end]: # 'Autogenerated link references'

packages/foam-core/test/__scaffold__/index.md

@@ -0,0 +1,9 @@
+# Index
+
+This file is intentionally missing the link reference definitions
+
+[[first-document]]
+
+[[second-document]]
+
+[[file-without-title]]

packages/foam-core/test/__scaffold__/second-document.md

@@ -0,0 +1,9 @@
+# Second Document
+
+This is just a link target for now.
+
+We can use it for other things later if needed.
+
+[//begin]: # 'Autogenerated link references for markdown compatibility'
+[first-document]: first-document 'First Document'
+[//end]: # 'Autogenerated link references'

packages/foam-core/test/__scaffold__/third-document.md

@@ -0,0 +1,11 @@
+# Third Document
+
+All the link references are correct in this file.
+
+[[first-document]]
+
+[[second-document]]
+
+
+[first-document]: first-document "First Document"
+[second-document]: second-document "Second Document"

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

@@ -1,11 +1,25 @@
 import { NoteGraph, Note } from '../src/note-graph';
 
+const position = {
+  start: { line: 0, column: 0 },
+  end: { line: 0, column: 0 },
+};
+
+const documentEnd = position.end;
+const eol = '\n';
+
 describe('Note graph', () => {
   it('Adds notes to graph', () => {
     const graph = new NoteGraph();
-    graph.setNote(new Note('page-a', 'page-a', [], '/page-a.md', ''));
-    graph.setNote(new Note('page-b', 'page-b', [], '/page-b.md', ''));
-    graph.setNote(new Note('page-c', 'page-c', [], '/page-c.md', ''));
+    graph.setNote(
+      new Note('page-a', 'page-a', [], [], documentEnd, eol, '/page-a.md', '')
+    );
+    graph.setNote(
+      new Note('page-b', 'page-b', [], [], documentEnd, eol, '/page-b.md', '')
+    );
+    graph.setNote(
+      new Note('page-c', 'page-c', [], [], documentEnd, eol, '/page-c.md', '')
+    );
 
     expect(
       graph
@@ -17,17 +31,24 @@ describe('Note graph', () => {
 
   it('Detects forward links', () => {
     const graph = new NoteGraph();
-    graph.setNote(new Note('page-a', 'page-a', [], '/page-a.md', ''));
+    graph.setNote(
+      new Note('page-a', 'page-a', [], [], documentEnd, eol, '/page-a.md', '')
+    );
     graph.setNote(
       new Note(
         'page-b',
         'page-b',
-        [{ to: 'page-a', text: 'go' }],
+        [{ to: 'page-a', text: 'go', position }],
+        [],
+        documentEnd,
+        eol,
         '/page-b.md',
         ''
       )
     );
-    graph.setNote(new Note('page-c', 'page-c', [], '/page-c.md', ''));
+    graph.setNote(
+      new Note('page-c', 'page-c', [], [], documentEnd, eol, '/page-c.md', '')
+    );
 
     expect(
       graph
@@ -39,17 +60,24 @@ describe('Note graph', () => {
 
   it('Detects backlinks', () => {
     const graph = new NoteGraph();
-    graph.setNote(new Note('page-a', 'page-a', [], '/page-a.md', ''));
+    graph.setNote(
+      new Note('page-a', 'page-a', [], [], documentEnd, eol, '/page-a.md', '')
+    );
     graph.setNote(
       new Note(
         'page-b',
         'page-b',
-        [{ to: 'page-a', text: 'go' }],
+        [{ to: 'page-a', text: 'go', position }],
+        [],
+        documentEnd,
+        eol,
         '/page-b.md',
         ''
       )
     );
-    graph.setNote(new Note('page-c', 'page-c', [], '/page-c.md', ''));
+    graph.setNote(
+      new Note('page-c', 'page-c', [], [], documentEnd, eol, '/page-c.md', '')
+    );
 
     expect(
       graph
@@ -62,7 +90,9 @@ describe('Note graph', () => {
   it('Fails when accessing non-existing node', () => {
     expect(() => {
       const graph = new NoteGraph();
-      graph.setNote(new Note('page-a', 'page-a', [], '/path-b.md', ''));
+      graph.setNote(
+        new Note('page-a', 'page-a', [], [], documentEnd, eol, '/path-b.md', '')
+      );
       graph.getNote('non-existing');
     }).toThrow();
   });
@@ -73,7 +103,10 @@ describe('Note graph', () => {
       new Note(
         'page-a',
         'page-a',
-        [{ to: 'non-existing', text: 'does not exist' }],
+        [{ to: 'non-existing', text: 'does not exist', position }],
+        [],
+        documentEnd,
+        eol,
         '/path-b.md',
         ''
       )
@@ -83,17 +116,24 @@ describe('Note graph', () => {
 
   it('Updates links when modifying note', () => {
     const graph = new NoteGraph();
-    graph.setNote(new Note('page-a', 'page-a', [], '/page-a.md', ''));
+    graph.setNote(
+      new Note('page-a', 'page-a', [], [], documentEnd, eol, '/page-a.md', '')
+    );
     graph.setNote(
       new Note(
         'page-b',
         'page-b',
-        [{ to: 'page-a', text: 'go' }],
+        [{ to: 'page-a', text: 'go', position }],
+        [],
+        documentEnd,
+        eol,
         '/page-b.md',
         ''
       )
     );
-    graph.setNote(new Note('page-c', 'page-c', [], '/page-c.md', ''));
+    graph.setNote(
+      new Note('page-c', 'page-c', [], [], documentEnd, eol, '/page-c.md', '')
+    );
 
     expect(
       graph
@@ -118,7 +158,10 @@ describe('Note graph', () => {
       new Note(
         'page-b',
         'page-b',
-        [{ to: 'page-c', text: 'go' }],
+        [{ to: 'page-c', text: 'go', position }],
+        [],
+        documentEnd,
+        eol,
         '/path-2b.md',
         ''
       )

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

@@ -0,0 +1,49 @@
+import * as path from 'path';
+import { NoteGraph, Note } from '../../src/note-graph';
+import { generateHeading } from '../../src/janitor';
+import { initializeNoteGraph } from '../../src/initialize-note-graph';
+
+describe('generateHeadings', () => {
+  let _graph: NoteGraph;
+
+  beforeAll(async () => {
+    _graph = await initializeNoteGraph(path.join(__dirname, '../__scaffold__'));
+  });
+
+  it('should add heading to a file that does not have them', () => {
+    const note = _graph.getNote('file-without-title') as Note;
+    const expected = {
+      newText: `# File without Title
+
+`,
+      range: {
+        start: {
+          line: 0,
+          column: 0,
+          offset: 0,
+        },
+        end: {
+          line: 0,
+          column: 0,
+          offset: 0,
+        },
+      },
+    };
+
+    const actual = generateHeading(note!);
+
+    expect(actual!.range.start).toEqual(expected.range.start);
+    expect(actual!.range.end).toEqual(expected.range.end);
+    expect(actual!.newText).toEqual(expected.newText);
+  });
+
+  it('should not cause any changes to a file that has a heading', () => {
+    const note = _graph.getNote('index') as Note;
+
+    const expected = null;
+
+    const actual = generateHeading(note!);
+
+    expect(actual).toEqual(expected);
+  });
+});

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

@@ -0,0 +1,106 @@
+import * as path from 'path';
+import { NoteGraph, Note } from '../../src/note-graph';
+import { generateLinkReferences } from '../../src/janitor';
+import { initializeNoteGraph } from '../../src/initialize-note-graph';
+
+describe('generateLinkReferences', () => {
+  let _graph: NoteGraph;
+
+  beforeAll(async () => {
+    _graph = await initializeNoteGraph(path.join(__dirname, '../__scaffold__'));
+  });
+
+  it('initialised test graph correctly', () => {
+    expect(_graph.getNotes().length).toEqual(5);
+  });
+
+  it('should add link references to a file that does not have them', () => {
+    const note = _graph.getNote('index') as Note;
+    const expected = {
+      newText: `
+[first-document]: first-document "First Document"
+[second-document]: second-document "Second Document"
+[file-without-title]: file-without-title "file-without-title"`,
+      range: {
+        start: {
+          line: 10,
+          column: 1,
+          offset: 140,
+        },
+        end: {
+          line: 10,
+          column: 1,
+          offset: 140,
+        },
+      },
+    };
+
+    const actual = generateLinkReferences(note!, _graph);
+
+    expect(actual!.range.start).toEqual(expected.range.start);
+    expect(actual!.range.end).toEqual(expected.range.end);
+    expect(actual!.newText).toEqual(expected.newText);
+  });
+
+  it('should remove link definitions from a file that has them, if no links are present', () => {
+    const note = _graph.getNote('second-document') as Note;
+
+    const expected = {
+      newText: '',
+      range: {
+        start: {
+          line: 7,
+          column: 1,
+          offset: 105,
+        },
+        end: {
+          line: 9,
+          column: 43,
+          offset: 269,
+        },
+      },
+    };
+
+    const actual = generateLinkReferences(note!, _graph);
+
+    expect(actual!.range.start).toEqual(expected.range.start);
+    expect(actual!.range.end).toEqual(expected.range.end);
+    expect(actual!.newText).toEqual(expected.newText);
+  });
+
+  it('should update link definitions if they are present but changed', () => {
+    const note = _graph.getNote('first-document') as Note;
+
+    const expected = {
+      newText: `[file-without-title]: file-without-title "file-without-title"`,
+      range: {
+        start: {
+          line: 5,
+          column: 1,
+          offset: 42,
+        },
+        end: {
+          line: 7,
+          column: 43,
+          offset: 209,
+        },
+      },
+    };
+
+    const actual = generateLinkReferences(note!, _graph);
+
+    expect(actual!.range.start).toEqual(expected.range.start);
+    expect(actual!.range.end).toEqual(expected.range.end);
+    expect(actual!.newText).toEqual(expected.newText);
+  });
+
+  it('should not cause any changes if link reference definitions were up to date', () => {
+    const note = _graph.getNote('third-document') as Note;
+
+    const expected = null;
+
+    const actual = generateLinkReferences(note!, _graph);
+
+    expect(actual).toEqual(expected);
+  });
+});

packages/foam-core/test/loose-link-reference.test.ts

@@ -0,0 +1,44 @@
+import {LooseLinkReference} from '../src/LooseLinkReference'
+describe('LooseLinkReference', () => {
+    it('Will match based on different use of accents, punctuation and capitalization differences', () => {
+        const listOfFiles = [
+            new LooseLinkReference('Zoë File')
+        ];
+
+        expect(
+            LooseLinkReference.findBestMatch(
+                listOfFiles, 
+                new LooseLinkReference('zoe-file')
+            ).original
+        ).toEqual('Zoë File');
+    });
+
+    it('Will match against exactly matches in preference of loose matches', () => {
+        const looseMatch = new LooseLinkReference('zoe');
+        const exactMatch = new LooseLinkReference('zoë');
+        
+        const looseFirstList = [
+            looseMatch,
+            exactMatch
+        ];
+
+        const exactFirstList = [
+            exactMatch,
+            looseMatch
+        ];
+
+        expect(
+            LooseLinkReference.findBestMatch(
+                looseFirstList, 
+                new LooseLinkReference('zoë')
+            ).original
+        ).toEqual('zoë');
+
+        expect(
+            LooseLinkReference.findBestMatch(
+                exactFirstList, 
+                new LooseLinkReference('zoë')
+            ).original
+        ).toEqual('zoë');
+    });
+});

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

@@ -1,5 +1,8 @@
-import { createNoteFromMarkdown } from '../src/markdown-provider';
-import { NoteGraph } from '../src/note-graph';
+import {
+  createNoteFromMarkdown,
+  createMarkdownReferences,
+} from '../src/markdown-provider';
+import { NoteGraph, Note } from '../src/note-graph';
 
 const pageA = `
 # Page A
@@ -18,12 +21,16 @@ const pageC = `
 # Page C
 `;
 
+const pageD = `
+This file has no heading.
+`
+
 describe('Markdown loader', () => {
   it('Converts markdown to notes', () => {
     const graph = new NoteGraph();
-    graph.setNote(createNoteFromMarkdown('page-a', pageA));
-    graph.setNote(createNoteFromMarkdown('page-b', pageB));
-    graph.setNote(createNoteFromMarkdown('page-c', pageC));
+    graph.setNote(createNoteFromMarkdown('page-a', pageA, '\n'));
+    graph.setNote(createNoteFromMarkdown('page-b', pageB, '\n'));
+    graph.setNote(createNoteFromMarkdown('page-c', pageC, '\n'));
 
     expect(
       graph
@@ -35,9 +42,9 @@ describe('Markdown loader', () => {
 
   it('Parses wikilinks correctly', () => {
     const graph = new NoteGraph();
-    graph.setNote(createNoteFromMarkdown('page-a', pageA));
-    graph.setNote(createNoteFromMarkdown('page-b', pageB));
-    graph.setNote(createNoteFromMarkdown('page-c', pageC));
+    graph.setNote(createNoteFromMarkdown('page-a', pageA, '\n'));
+    graph.setNote(createNoteFromMarkdown('page-b', pageB, '\n'));
+    graph.setNote(createNoteFromMarkdown('page-c', pageC, '\n'));
 
     expect(graph.getBacklinks('page-b').map(link => link.from)).toEqual([
       'page-a',
@@ -48,3 +55,65 @@ describe('Markdown loader', () => {
     ]);
   });
 });
+
+describe('Note Title', () => {
+  it('should initialize note title if heading exists', () => {
+    const graph = new NoteGraph();
+    graph.setNote(createNoteFromMarkdown('page-a', pageA, '\n'));
+
+    const pageANoteTitle = (graph.getNote('page-a') as Note).title;
+    expect(pageANoteTitle).toBe('Page A');
+  });
+
+  it('should not initialize note title if heading does not exist', () => {
+    const graph = new NoteGraph();
+    graph.setNote(createNoteFromMarkdown('page-d', pageD, '\n'));
+
+    const pageANoteTitle = (graph.getNote('page-d') as Note).title;
+    expect(pageANoteTitle).toBe(null);
+  });
+})
+
+describe('wikilinks definitions', () => {
+  it('can generate links without file extension when includeExtension = false', () => {
+    const graph = new NoteGraph();
+    const noteA = createNoteFromMarkdown('dir1/page-a.md', pageA, '\n');
+    const noteB = createNoteFromMarkdown('dir1/page-b.md', pageB, '\n');
+    const noteC = createNoteFromMarkdown('dir1/page-c.md', pageC, '\n');
+    graph.setNote(noteA);
+    graph.setNote(noteB);
+    graph.setNote(noteC);
+
+    const noExtRefs = createMarkdownReferences(graph, noteA.id, false);
+    expect(noExtRefs.map(r => r.url)).toEqual(['page-b', 'page-c']);
+  });
+
+  it('can generate links with file extension when includeExtension = true', () => {
+    const graph = new NoteGraph();
+    const noteA = createNoteFromMarkdown('dir1/page-a.md', pageA, '\n');
+    const noteB = createNoteFromMarkdown('dir1/page-b.md', pageB, '\n');
+    const noteC = createNoteFromMarkdown('dir1/page-c.md', pageC, '\n');
+    graph.setNote(noteA);
+    graph.setNote(noteB);
+    graph.setNote(noteC);
+
+    const extRefs = createMarkdownReferences(graph, noteA.id, true);
+    expect(extRefs.map(r => r.url)).toEqual(['page-b.md', 'page-c.md']);
+  });
+
+  it('use relative paths', () => {
+    const graph = new NoteGraph();
+    const noteA = createNoteFromMarkdown('dir1/page-a.md', pageA, '\n');
+    const noteB = createNoteFromMarkdown('dir2/page-b.md', pageB, '\n');
+    const noteC = createNoteFromMarkdown('dir3/page-c.md', pageC, '\n');
+    graph.setNote(noteA);
+    graph.setNote(noteB);
+    graph.setNote(noteC);
+
+    const extRefs = createMarkdownReferences(graph, noteA.id, true);
+    expect(extRefs.map(r => r.url)).toEqual([
+      '../dir2/page-b.md',
+      '../dir3/page-c.md',
+    ]);
+  });
+});

packages/foam-core/tsconfig.json

@@ -1,6 +1,9 @@
 {
   "extends": "../../tsconfig.base.json",
-  "include": ["src", "types"],
+  "include": [
+    "src",
+    "types"
+  ],
   "compilerOptions": {
     "composite": true,
     "declaration": true,
@@ -10,13 +13,14 @@
     "rootDir": "./src",
     // for references
     "baseUrl": "src",
-    "lib": ["esnext"],
-
+    "lib": [
+      "esnext"
+    ],
     "module": "esnext",
     "importHelpers": true,
     "sourceMap": true,
     "strict": true,
-    "noUnusedLocals": true,
+    // "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
@@ -27,4 +31,4 @@
     // },
     // "jsx": "react",
   },
-}
+}

packages/foam-core/types/utils.d.ts

@@ -1 +1 @@
-declare module 'remark-wiki-link';
+declare module 'remark-wiki-link';

packages/foam-core/yarn.lock

@@ -1077,6 +1077,11 @@
   resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.44.tgz#980cc5a29a3ef3bea6ff1f7d021047d7ea575e21"
   integrity sha512-iaIVzr+w2ZJ5HkidlZ3EJM8VTZb2MJLCjw3V+505yVts0gRC4UMvjw0d1HPtGqI/HQC/KdsYtayfzl+AXY2R8g==
 
+"@types/graphlib@^2.1.6":
+  version "2.1.6"
+  resolved "https://registry.yarnpkg.com/@types/graphlib/-/graphlib-2.1.6.tgz#5c7b515bfadc08d737f2e84fadbd151117c73207"
+  integrity sha512-os2Xj+pV/iwLkLX17LWuXdPooA4Jf4xg8WSdKPUi0tCSseP95oikcA1irOgVl3K2QYnoXrjJT3qVZeQ1uskB7g==
+
 "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0":
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.3.tgz#4ba8ddb720221f432e443bd5f9117fd22cfd4762"
@@ -2843,6 +2848,13 @@ graceful-fs@^4.1.11, graceful-fs@^4.1.15, graceful-fs@^4.1.2, graceful-fs@^4.1.6
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.4.tgz#2256bde14d3632958c465ebc96dc467ca07a29fb"
   integrity sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==
 
+graphlib@^2.1.8:
+  version "2.1.8"
+  resolved "https://registry.yarnpkg.com/graphlib/-/graphlib-2.1.8.tgz#5761d414737870084c92ec7b5dbcb0592c9d35da"
+  integrity sha512-jcLLfkpoVGmH7/InMC/1hIvOPSUh38oJtGhvrOFGzioE1DZ+0YW16RgmOJhHiuWTvGiJQ9Z1Ik43JvkRPRvE+A==
+  dependencies:
+    lodash "^4.17.15"
+
 growly@^1.3.0:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
@@ -3986,10 +3998,10 @@ lodash.sortby@^4.7.0:
   resolved "https://registry.yarnpkg.com/lodash.sortby/-/lodash.sortby-4.7.0.tgz#edd14c824e2cc9c1e0b0a1b42bb5210516a42438"
   integrity sha1-7dFMgk4sycHgsKG0K7UhBRakJDg=
 
-lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.4:
-  version "4.17.15"
-  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.15.tgz#b447f6670a0455bbfeedd11392eff330ea097548"
-  integrity sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==
+lodash@^4.17.13, lodash@^4.17.14, lodash@^4.17.15, lodash@^4.17.19, lodash@^4.17.4:
+  version "4.17.19"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.19.tgz#e48ddedbe30b3321783c5b4301fbd353bc1e4a4b"
+  integrity sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ==
 
 log-symbols@^2.2.0:
   version "2.2.0"
@@ -5975,6 +5987,15 @@ unist-util-visit@^2.0.0:
     unist-util-is "^4.0.0"
     unist-util-visit-parents "^3.0.0"
 
+unist-util-visit@^2.0.2:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-2.0.3.tgz#c3703893146df47203bb8a9795af47d7b971208c"
+  integrity sha512-iJ4/RczbJMkD0712mGktuGpm/U4By4FfDonL7N/9tATGIF4imikjOuagyMY53tnZq3NP6BcmlrHhEKAfGWjh7Q==
+  dependencies:
+    "@types/unist" "^2.0.0"
+    unist-util-is "^4.0.0"
+    unist-util-visit-parents "^3.0.0"
+
 universalify@^0.1.0:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66"

packages/foam-vscode/package.json

@@ -15,7 +15,8 @@
   ],
   "activationEvents": [
     "workspaceContains:.vscode/foam.json",
-    "onCommand:foam-vscode.update-wikilinks"
+    "onCommand:foam-vscode.update-wikilinks",
+    "onCommand:foam-vscode.open-daily-note"
   ],
   "main": "./out/extension.js",
   "contributes": {
@@ -23,6 +24,58 @@
       {
         "command": "foam-vscode.update-wikilinks",
         "title": "Foam: Update Markdown Reference List"
+      },
+      {
+        "command": "foam-vscode.open-daily-note",
+        "title": "Foam: Open Daily Note"
+      }
+    ],
+    "configuration": {
+      "title": "Foam",
+      "properties": {
+        "foam.edit.linkReferenceDefinitions": {
+          "type": "string",
+          "default": "withoutExtensions",
+          "enum": ["withExtensions", "withoutExtensions"],
+          "enumDescriptions": [
+            "Include extension in wikilinks paths",
+            "Remove extension in wikilink paths"
+          ]
+        },
+        "foam.openDailyNote.fileExtension": {
+          "type": "string",
+          "scope": "resource",
+          "default": "md"
+        },
+        "foam.openDailyNote.filenameFormat": {
+          "type": "string",
+          "default": "isoDate",
+          "markdownDescription": "Specifies how the daily note filename is formatted. See the [dateformat docs](https://www.npmjs.com/package/dateformat) for valid formats",
+          "scope": "resource"
+        },
+        "foam.openDailyNote.titleFormat": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null,
+          "markdownDescription": "Specifies how the daily note title is formatted. Will default to the filename format if set to null. See the [dateformat docs](https://www.npmjs.com/package/dateformat) for valid formats",
+          "scope": "resource"
+        },
+        "foam.openDailyNote.directory": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "default": null,
+          "description": "The directory into which daily notes should be created. Defaults to the workspace root."
+        }
+      }
+    },
+    "keybindings": [
+      {
+        "command": "foam-vscode.open-daily-note",
+        "key": "alt+d"
       }
     ]
   },
@@ -37,6 +90,7 @@
     "publish-extension": "npx vsce publish && yarn npm-cleanup"
   },
   "devDependencies": {
+    "@types/dateformat": "^3.0.1",
     "@types/glob": "^7.1.1",
     "@types/node": "^13.11.0",
     "@types/vscode": "^1.45.1",
@@ -49,6 +103,7 @@
     "vscode-test": "^1.3.0"
   },
   "dependencies": {
+    "dateformat": "^3.0.3",
     "foam-core": "^0.2.0"
   }
 }

packages/foam-vscode/src/extension.ts

@@ -4,228 +4,36 @@
  */
 "use strict";
 
-import { uniq } from "lodash";
-import {
-  CancellationToken,
-  CodeLens,
-  CodeLensProvider,
-  commands,
-  EndOfLine,
-  ExtensionContext,
-  languages,
-  Range,
-  TextEditor,
-  TextDocument,
-  TextDocumentWillSaveEvent,
-  window,
-  workspace,
-  Position
-} from "vscode";
+import * as fs from "fs";
+import { workspace, ExtensionContext, window, EndOfLine } from "vscode";
 
-import { createMarkdownReferences, createNoteFromMarkdown } from "foam-core";
-import { basename, dirname, relative } from "path";
-import * as ws from "./workspace";
-import { config } from "process";
-
-/**
- * Workspace config
- */
-const docConfig = { tab: "  ", eol: "\r\n" };
-const mdDocSelector = [
-  { language: "markdown", scheme: "file" },
-  { language: "markdown", scheme: "untitled" }
-];
-
-function loadDocConfig() {
-  // Load workspace config
-  let activeEditor = window.activeTextEditor;
-  if (!activeEditor) {
-    console.log("Failed to load config, no active editor");
-    return;
-  }
-
-  docConfig.eol = activeEditor.document.eol === EndOfLine.CRLF ? "\r\n" : "\n";
-
-  let tabSize = Number(activeEditor.options.tabSize);
-  let insertSpaces = activeEditor.options.insertSpaces;
-  if (insertSpaces) {
-    docConfig.tab = " ".repeat(tabSize);
-  } else {
-    docConfig.tab = "\t";
-  }
-}
-
-const REFERENCE_HEADER = `[//begin]: # "Autogenerated link references for markdown compatibility"`;
-const REFERENCE_FOOTER = `[//end]: # "Autogenerated link references"`;
+import { createNoteFromMarkdown, createFoam, FoamConfig } from "foam-core";
+import { features } from "./features";
 
 export function activate(context: ExtensionContext) {
-  ws.ready.then(foam => {
-    context.subscriptions.push(
-      commands.registerCommand(
-        "foam-vscode.update-wikilinks",
-        updateReferenceList
-      ),
-      workspace.onWillSaveTextDocument(e => {
-        if (e.document.languageId === "markdown") {
-          foam.setNote(
-            createNoteFromMarkdown(e.document.fileName, e.document.getText())
-          );
-          e.waitUntil(updateReferenceList());
-        }
-      }),
-      languages.registerCodeLensProvider(
-        mdDocSelector,
-        new WikilinkReferenceCodeLensProvider()
-      )
-    );
+  const foamPromise = bootstrap(getConfig());
+  features.forEach(f => {
+    f.activate(context, foamPromise);
   });
 }
 
-async function createReferenceList() {
-  let editor = window.activeTextEditor;
-  if (!editor || !isMdEditor(editor)) {
-    return;
-  }
-
-  let refs = await generateReferenceList(editor.document);
-  if (refs && refs.length) {
-    await editor.edit(function(editBuilder) {
-      if (editor) {
-        const spacing = hasEmptyTrailing
-          ? docConfig.eol
-          : docConfig.eol + docConfig.eol;
-
-        editBuilder.insert(
-          new Position(editor.document.lineCount, 0),
-          spacing + refs.join(docConfig.eol)
-        );
-      }
-    });
-  }
-}
-
-async function updateReferenceList() {
-  const editor = window.activeTextEditor;
-
-  if (!editor || !isMdEditor(editor)) {
-    return;
-  }
-
-  loadDocConfig();
-
-  const doc = editor.document;
-  const range = detectReferenceListRange(doc);
-
-  if (!range) {
-    await createReferenceList();
-  } else {
-    const refs = await generateReferenceList(doc);
-
-    // references must always be preceded by an empty line
-    const spacing = doc.lineAt(range.start.line - 1).isEmptyOrWhitespace
-      ? ""
-      : docConfig.eol;
-
-    await editor.edit(editBuilder => {
-      editBuilder.replace(range, spacing + refs.join(docConfig.eol));
-    });
-  }
-}
-
-async function generateReferenceList(doc: TextDocument): Promise<string[]> {
-  const filePath = doc.fileName;
-
-  const id = dropExtension(basename(filePath));
-
-  // @todo fix hack
-  const foam = await ws.ready;
-
-  const references = uniq(
-    createMarkdownReferences(foam, id).map(
-      link => `[${link.linkText}]: ${link.wikiLink} "${link.pageTitle}"`
-    )
+const bootstrap = async (config: FoamConfig) => {
+  const files = await workspace.findFiles("**/*");
+  const foam = createFoam(config);
+  await Promise.all(
+    files
+      .filter(f => f.scheme === "file" && f.path.match(/\.(md|mdx|markdown)/i))
+      .map(f => {
+        return fs.promises.readFile(f.fsPath).then(data => {
+          const markdown = (data || "").toString();
+          const eol = window.activeTextEditor?.document?.eol === EndOfLine.CRLF ? "\r\n" : "\n";
+          foam.notes.setNote(createNoteFromMarkdown(f.fsPath, markdown, eol));
+        });
+      })
   );
+  return foam;
+};
 
-  if (references.length) {
-    return [REFERENCE_HEADER, ...references, REFERENCE_FOOTER];
-  }
-
-  return [];
-}
-
-/**
- * Find the range of existing reference list
- * @param doc
- */
-function detectReferenceListRange(doc: TextDocument): Range {
-  const fullText = doc.getText();
-
-  const headerIndex = fullText.indexOf(REFERENCE_HEADER);
-  const footerIndex = fullText.lastIndexOf(REFERENCE_FOOTER);
-
-  if (headerIndex < 0) {
-    return null;
-  }
-
-  const headerLine =
-    fullText.substring(0, headerIndex).split(docConfig.eol).length - 1;
-
-  const footerLine =
-    fullText.substring(0, footerIndex).split(docConfig.eol).length - 1;
-
-  if (headerLine >= footerLine) {
-    return null;
-  }
-
-  return new Range(
-    new Position(headerLine, 0),
-    new Position(footerLine, REFERENCE_FOOTER.length)
-  );
-}
-
-function hasEmptyTrailing(doc: TextDocument): boolean {
-  return doc.lineAt(doc.lineCount - 1).isEmptyOrWhitespace;
-}
-
-function getText(range: Range): string {
-  return window.activeTextEditor.document.getText(range);
-}
-
-function isMdEditor(editor: TextEditor) {
-  return editor && editor.document && editor.document.languageId === "markdown";
-}
-
-function dropExtension(path: string): string {
-  const parts = path.split(".");
-  parts.pop();
-  return parts.join(".");
-}
-
-class WikilinkReferenceCodeLensProvider implements CodeLensProvider {
-  public provideCodeLenses(
-    document: TextDocument,
-    _: CancellationToken
-  ): CodeLens[] | Thenable<CodeLens[]> {
-    loadDocConfig();
-
-    let range = detectReferenceListRange(document);
-    if (!range) {
-      return [];
-    }
-
-    return generateReferenceList(document).then(refs => {
-      const oldRefs = getText(range).replace(/\r?\n|\r/g, docConfig.eol);
-      const newRefs = refs.join(docConfig.eol);
-
-      let status = oldRefs === newRefs ? "up to date" : "out of date";
-
-      return [
-        new CodeLens(range, {
-          arguments: [],
-          title: `Link references (${status})`,
-          command: ""
-        })
-      ];
-    });
-  }
-}
+const getConfig = () => {
+  return {};
+};

packages/foam-vscode/src/features/index.ts

@@ -0,0 +1,5 @@
+import createReferences from "./wikilink-reference-generation";
+import openDailyNote from "./open-daily-note";
+import { FoamFeature } from "../types";
+
+export const features: FoamFeature[] = [createReferences, openDailyNote];

packages/foam-vscode/src/features/open-daily-note.ts

@@ -0,0 +1,96 @@
+import {
+  window,
+  workspace,
+  Uri,
+  WorkspaceConfiguration,
+  ExtensionContext,
+  commands,
+} from "vscode";
+import { dirname, join } from "path";
+import dateFormat = require("dateformat");
+import fs = require("fs");
+import { FoamFeature } from "../types";
+
+const feature: FoamFeature = {
+  activate: async (context: ExtensionContext) => {
+    context.subscriptions.push(
+      commands.registerCommand("foam-vscode.open-daily-note", openDailyNote)
+    );
+  },
+};
+
+async function openDailyNote() {
+  const foamConfiguration = workspace.getConfiguration("foam");
+  const currentDate = new Date();
+
+  const dailyNotePath = getDailyNotePath(foamConfiguration, currentDate);
+
+  createDailyNoteIfNotExists(foamConfiguration, dailyNotePath, currentDate);
+  await focusDailyNote(dailyNotePath);
+}
+
+function getDailyNotePath(configuration: WorkspaceConfiguration, date: Date) {
+  const rootDirectory = workspace.workspaceFolders[0].uri.fsPath;
+  const dailyNoteDirectory: string =
+    configuration.get("openDailyNote.directory") ?? ".";
+  const dailyNoteFilename = getDailyNoteFileName(configuration, date);
+
+  return join(rootDirectory, dailyNoteDirectory, dailyNoteFilename);
+}
+
+function getDailyNoteFileName(
+  configuration: WorkspaceConfiguration,
+  date: Date
+): string {
+  const filenameFormat: string = configuration.get(
+    "openDailyNote.filenameFormat"
+  );
+  const fileExtension: string = configuration.get(
+    "openDailyNote.fileExtension"
+  );
+
+  return `${dateFormat(date, filenameFormat, false)}.${fileExtension}`;
+}
+
+async function createDailyNoteIfNotExists(
+  configuration: WorkspaceConfiguration,
+  dailyNotePath: string,
+  currentDate: Date
+) {
+  if (await pathExists(dailyNotePath)) {
+    return;
+  }
+
+  createDailyNoteDirectoryIfNotExists(dailyNotePath);
+
+  const titleFormat: string =
+    configuration.get("openDailyNote.titleFormat") ??
+    configuration.get("openDailyNote.filenameFormat");
+
+  await fs.promises.writeFile(
+    dailyNotePath,
+    `# ${dateFormat(currentDate, titleFormat, false)}\r\n`
+  );
+}
+
+async function createDailyNoteDirectoryIfNotExists(dailyNotePath: string) {
+  const dailyNoteDirectory = dirname(dailyNotePath);
+
+  if (!(await pathExists(dailyNoteDirectory))) {
+    await fs.promises.mkdir(dailyNoteDirectory, { recursive: true });
+  }
+}
+
+async function focusDailyNote(dailyNotePath: string) {
+  const document = await workspace.openTextDocument(Uri.parse(dailyNotePath));
+  window.showTextDocument(document);
+}
+
+async function pathExists(path: string) {
+  return fs.promises
+    .access(path, fs.constants.F_OK)
+    .then(() => true)
+    .catch(() => false);
+}
+
+export default feature;

packages/foam-vscode/src/features/wikilink-reference-generation.ts

@@ -0,0 +1,215 @@
+import { uniq } from "lodash";
+import {
+  CancellationToken,
+  CodeLens,
+  CodeLensProvider,
+  commands,
+  ExtensionContext,
+  languages,
+  Range,
+  TextDocument,
+  window,
+  workspace,
+  Position
+} from "vscode";
+
+import {
+  createMarkdownReferences,
+  stringifyMarkdownLinkReferenceDefinition,
+  createNoteFromMarkdown,
+  NoteGraph,
+  Foam
+} from "foam-core";
+import { basename } from "path";
+import {
+  hasEmptyTrailing,
+  docConfig,
+  loadDocConfig,
+  isMdEditor,
+  mdDocSelector,
+  getText,
+  dropExtension
+} from "../utils";
+import { FoamFeature } from "../types";
+
+const feature: FoamFeature = {
+  activate: async (context: ExtensionContext, foamPromise: Promise<Foam>) => {
+    const foam = await foamPromise;
+    context.subscriptions.push(
+      commands.registerCommand("foam-vscode.update-wikilinks", () =>
+        updateReferenceList(foam.notes)
+      ),
+      workspace.onWillSaveTextDocument(e => {
+        if (e.document.languageId === "markdown") {
+          foam.notes.setNote(
+            createNoteFromMarkdown(
+              e.document.fileName,
+              e.document.getText(),
+              docConfig.eol
+            )
+          );
+          e.waitUntil(updateReferenceList(foam.notes));
+        }
+      }),
+      languages.registerCodeLensProvider(
+        mdDocSelector,
+        new WikilinkReferenceCodeLensProvider(foam.notes)
+      )
+    );
+  }
+};
+
+const REFERENCE_HEADER = `[//begin]: # "Autogenerated link references for markdown compatibility"`;
+const REFERENCE_FOOTER = `[//end]: # "Autogenerated link references"`;
+
+async function createReferenceList(foam: NoteGraph) {
+  let editor = window.activeTextEditor;
+  if (!editor || !isMdEditor(editor)) {
+    return;
+  }
+
+  let refs = await generateReferenceList(foam, editor.document);
+  if (refs && refs.length) {
+    await editor.edit(function(editBuilder) {
+      if (editor) {
+        const spacing = hasEmptyTrailing
+          ? docConfig.eol
+          : docConfig.eol + docConfig.eol;
+
+        editBuilder.insert(
+          new Position(editor.document.lineCount, 0),
+          spacing + refs.join(docConfig.eol)
+        );
+      }
+    });
+  }
+}
+
+async function updateReferenceList(foam: NoteGraph) {
+  const editor = window.activeTextEditor;
+
+  if (!editor || !isMdEditor(editor)) {
+    return;
+  }
+
+  loadDocConfig();
+
+  const doc = editor.document;
+  const range = detectReferenceListRange(doc);
+
+  if (!range) {
+    await createReferenceList(foam);
+  } else {
+    const refs = await generateReferenceList(foam, doc);
+
+    // references must always be preceded by an empty line
+    const spacing = doc.lineAt(range.start.line - 1).isEmptyOrWhitespace
+      ? ""
+      : docConfig.eol;
+
+    await editor.edit(editBuilder => {
+      editBuilder.replace(range, spacing + refs.join(docConfig.eol));
+    });
+  }
+}
+
+enum LinkReferenceDefinitionsSetting {
+  withExtensions = "withExtensions",
+  withoutExtensions = "withoutExtensions"
+}
+
+async function generateReferenceList(
+  foam: NoteGraph,
+  doc: TextDocument
+): Promise<string[]> {
+  const filePath = doc.fileName;
+
+  const id = dropExtension(basename(filePath));
+
+  const linkDefinitionSetting: LinkReferenceDefinitionsSetting =
+    workspace
+      .getConfiguration("foam.edit")
+      .get<LinkReferenceDefinitionsSetting>("linkReferenceDefinitions") ??
+    LinkReferenceDefinitionsSetting.withoutExtensions;
+
+  const includeExtensions =
+    linkDefinitionSetting === LinkReferenceDefinitionsSetting.withExtensions;
+  const references = uniq(
+    createMarkdownReferences(foam, id, includeExtensions).map(
+      stringifyMarkdownLinkReferenceDefinition
+    )
+  );
+
+  if (references.length) {
+    return [REFERENCE_HEADER, ...references, REFERENCE_FOOTER];
+  }
+
+  return [];
+}
+
+/**
+ * Find the range of existing reference list
+ * @param doc
+ */
+function detectReferenceListRange(doc: TextDocument): Range {
+  const fullText = doc.getText();
+
+  const headerIndex = fullText.indexOf(REFERENCE_HEADER);
+  const footerIndex = fullText.lastIndexOf(REFERENCE_FOOTER);
+
+  if (headerIndex < 0) {
+    return null;
+  }
+
+  const headerLine =
+    fullText.substring(0, headerIndex).split(docConfig.eol).length - 1;
+
+  const footerLine =
+    fullText.substring(0, footerIndex).split(docConfig.eol).length - 1;
+
+  if (headerLine >= footerLine) {
+    return null;
+  }
+
+  return new Range(
+    new Position(headerLine, 0),
+    new Position(footerLine, REFERENCE_FOOTER.length)
+  );
+}
+
+class WikilinkReferenceCodeLensProvider implements CodeLensProvider {
+  private foam: NoteGraph;
+
+  constructor(foam: NoteGraph) {
+    this.foam = foam;
+  }
+
+  public provideCodeLenses(
+    document: TextDocument,
+    _: CancellationToken
+  ): CodeLens[] | Thenable<CodeLens[]> {
+    loadDocConfig();
+
+    let range = detectReferenceListRange(document);
+    if (!range) {
+      return [];
+    }
+
+    return generateReferenceList(this.foam, document).then(refs => {
+      const oldRefs = getText(range).replace(/\r?\n|\r/g, docConfig.eol);
+      const newRefs = refs.join(docConfig.eol);
+
+      let status = oldRefs === newRefs ? "up to date" : "out of date";
+
+      return [
+        new CodeLens(range, {
+          arguments: [],
+          title: `Link references (${status})`,
+          command: ""
+        })
+      ];
+    });
+  }
+}
+
+export default feature;

packages/foam-vscode/src/types.d.ts

@@ -0,0 +1,6 @@
+import { ExtensionContext } from "vscode";
+import { Foam } from "foam-core";
+
+export interface FoamFeature {
+  activate: (context: ExtensionContext, foamPromise: Promise<Foam>) => void
+}

packages/foam-vscode/src/utils.ts

@@ -1,4 +1,4 @@
-import { EndOfLine, Range, TextDocument, window, Position } from "vscode";
+import { EndOfLine, Range, TextDocument, window, Position, TextEditor } from "vscode";
 
 export const docConfig = { tab: "  ", eol: "\r\n" };
 
@@ -26,6 +26,10 @@ export function loadDocConfig() {
   }
 }
 
+export function isMdEditor(editor: TextEditor) {
+  return editor && editor.document && editor.document.languageId === "markdown";
+}
+
 export function detectGeneratedCode(
   fullText: string,
   header: string,

packages/foam-vscode/src/workspace.ts

@@ -1,20 +0,0 @@
-import * as fs from "fs";
-import { workspace } from "vscode";
-import { NoteGraph, createNoteFromMarkdown } from "foam-core";
-
-// build initial index
-export const ready = (async () => {
-  const files = await workspace.findFiles("**/*");
-  const foam = new NoteGraph();
-  await Promise.all(
-    files
-      .filter(f => f.scheme === "file" && f.path.match(/\.(md|mdx|markdown)/i))
-      .map(f => {
-        return fs.promises.readFile(f.fsPath).then(data => {
-          const markdown = (data || "").toString();
-          foam.setNote(createNoteFromMarkdown(f.fsPath, markdown));
-        });
-      })
-  );
-  return foam;
-})();

readme.md

@@ -7,7 +7,7 @@
 # Foam
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-19-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 **Foam** is a personal knowledge management and sharing system inspired by [Roam Research](https://roamresearch.com/), built on [Visual Studio Code](https://code.visualstudio.com/) and [GitHub](https://github.com/).
@@ -58,29 +58,39 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://jevakallio.dev/"><img src="https://avatars1.githubusercontent.com/u/1203949?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Jani Eväkallio</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://joeprevite.com/"><img src="https://avatars3.githubusercontent.com/u/3806031?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Joe Previte</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/riccardoferretti"><img src="https://avatars3.githubusercontent.com/u/457005?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Riccardo</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://ojanaho.com/"><img src="https://avatars0.githubusercontent.com/u/2180090?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Janne Ojanaho</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://bypaulshen.com/"><img src="https://avatars3.githubusercontent.com/u/2266187?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Paul Shen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=paulshen" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/coffenbacher"><img src="https://avatars0.githubusercontent.com/u/245867?v=4?s=60" width="60px;" alt=""/><br /><sub><b>coffenbacher</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=coffenbacher" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://mathieu.dutour.me/"><img src="https://avatars2.githubusercontent.com/u/3254314?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Mathieu Dutour</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=mathieudutour" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://jevakallio.dev/"><img src="https://avatars1.githubusercontent.com/u/1203949?v=4" width="60px;" alt=""/><br /><sub><b>Jani Eväkallio</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jevakallio" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://joeprevite.com/"><img src="https://avatars3.githubusercontent.com/u/3806031?v=4" width="60px;" alt=""/><br /><sub><b>Joe Previte</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jsjoeio" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/riccardoferretti"><img src="https://avatars3.githubusercontent.com/u/457005?v=4" width="60px;" alt=""/><br /><sub><b>Riccardo</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=riccardoferretti" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://ojanaho.com/"><img src="https://avatars0.githubusercontent.com/u/2180090?v=4" width="60px;" alt=""/><br /><sub><b>Janne Ojanaho</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Code">💻</a> <a href="https://github.com/foambubble/foam/commits?author=jojanaho" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://bypaulshen.com/"><img src="https://avatars3.githubusercontent.com/u/2266187?v=4" width="60px;" alt=""/><br /><sub><b>Paul Shen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=paulshen" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/coffenbacher"><img src="https://avatars0.githubusercontent.com/u/245867?v=4" width="60px;" alt=""/><br /><sub><b>coffenbacher</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=coffenbacher" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://mathieu.dutour.me/"><img src="https://avatars2.githubusercontent.com/u/3254314?v=4" width="60px;" alt=""/><br /><sub><b>Mathieu Dutour</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=mathieudutour" title="Documentation">📖</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://github.com/presidentelect"><img src="https://avatars2.githubusercontent.com/u/1242300?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Michael Hansen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=presidentelect" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://klickverbot.at/"><img src="https://avatars1.githubusercontent.com/u/19335?v=4?s=60" width="60px;" alt=""/><br /><sub><b>David Nadlinger</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dnadlinger" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://pluckd.co/"><img src="https://avatars2.githubusercontent.com/u/20598571?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Fernando</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=MrCordeiro" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/jfgonzalez7"><img src="https://avatars3.githubusercontent.com/u/58857736?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Juan Gonzalez</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jfgonzalez7" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://www.louiechristie.com/"><img src="https://avatars1.githubusercontent.com/u/6807448?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Louie Christie</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=louiechristie" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SuperSandro2000" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/Skn0tt"><img src="https://avatars1.githubusercontent.com/u/14912729?v=4?s=60" width="60px;" alt=""/><br /><sub><b>Simon Knott</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skn0tt" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/presidentelect"><img src="https://avatars2.githubusercontent.com/u/1242300?v=4" width="60px;" alt=""/><br /><sub><b>Michael Hansen</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=presidentelect" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://klickverbot.at/"><img src="https://avatars1.githubusercontent.com/u/19335?v=4" width="60px;" alt=""/><br /><sub><b>David Nadlinger</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=dnadlinger" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://pluckd.co/"><img src="https://avatars2.githubusercontent.com/u/20598571?v=4" width="60px;" alt=""/><br /><sub><b>Fernando</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=MrCordeiro" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/jfgonzalez7"><img src="https://avatars3.githubusercontent.com/u/58857736?v=4" width="60px;" alt=""/><br /><sub><b>Juan Gonzalez</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=jfgonzalez7" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://www.louiechristie.com/"><img src="https://avatars1.githubusercontent.com/u/6807448?v=4" width="60px;" alt=""/><br /><sub><b>Louie Christie</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=louiechristie" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://supersandro.de/"><img src="https://avatars2.githubusercontent.com/u/7258858?v=4" width="60px;" alt=""/><br /><sub><b>Sandro</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=SuperSandro2000" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Skn0tt"><img src="https://avatars1.githubusercontent.com/u/14912729?v=4" width="60px;" alt=""/><br /><sub><b>Simon Knott</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=Skn0tt" title="Documentation">📖</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://styfle.dev/"><img src="https://avatars1.githubusercontent.com/u/229881?v=4?s=60" 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?s=60" 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?s=60" 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?s=60" 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://github.com/ayushbaweja"><img src="https://avatars1.githubusercontent.com/u/44344063?v=4?s=60" 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://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://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://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>
+    <td align="center"><a href="https://github.com/chirag-singhal"><img src="https://avatars3.githubusercontent.com/u/42653703?v=4" width="60px;" alt=""/><br /><sub><b>CHIRAG SINGHAL</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=chirag-singhal" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/lostintangent"><img src="https://avatars3.githubusercontent.com/u/116461?v=4" width="60px;" alt=""/><br /><sub><b>Jonathan Carter</b></sub></a><br /><a href="https://github.com/foambubble/foam/commits?author=lostintangent" title="Documentation">📖</a></td>
   </tr>
 </table>