Initial commit

.vscode/extensions.json

@@ -0,0 +1,26 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": [
+    // Foam's own extension
+    "foam.foam-vscode",
+
+    // Prettier for auto formatting code
+    "esbenp.prettier-vscode",
+
+    // GitLens for seeing version history inline
+    "eamodio.gitlens",
+
+    // Tons of markdown goodies (lists, tables of content, so much more)
+    "yzhang.markdown-all-in-one",
+
+    // [[wiki-links]], backlinking etc
+    "kortina.vscode-markdown-notes",
+
+    // Adds `show graph` command that displays graph of linked notes
+    "tchayen.markdown-links",
+
+    // Understated grayscale theme (light and dark variants)
+    "philipbe.theme-gray-matter"
+  ]
+}

.vscode/foam.json

@@ -0,0 +1,4 @@
+{
+  "purpose": "this file exists to tell the foam-vscode plugin that it's currently in a foam workspace",
+  "future": "we may use this for custom configuration"
+}

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+  "editor.minimap.enabled": false,
+  "editor.wrappingIndent": "indent",
+  "editor.overviewRulerBorder": false,
+  "editor.lineHeight": 24,
+  "workbench.colorTheme": "Gray Matter Light",
+  "[markdown]": {
+    "editor.quickSuggestions": true
+  },
+  "git.enableSmartCommit": true,
+  "git.postCommitCommand": "sync",
+  "files.exclude": {
+    "**/node_modules": true
+  },
+  "files.watcherExclude": {
+    "**/node_modules": true
+  },
+  "vscodeMarkdownNotes.noteCompletionConvention": "noExtension"
+}

_layouts/home.html

@@ -0,0 +1,12 @@
+---
+layout: default
+---
+
+{{ content }}
+
+<script type="text/javascript">
+  // Hack: Replace page-link with "Page Title"
+  document.querySelectorAll(".markdown-body a[title]").forEach((a) => {
+    a.innerText = a.title;
+  });
+</script>

_layouts/page.html

@@ -0,0 +1,12 @@
+---
+layout: default
+---
+
+{{ content }}
+
+<script type="text/javascript">
+  // Hack: Replace page-link with "Page Title"
+  document.querySelectorAll(".markdown-body a[title]").forEach((a) => {
+    a.innerText = a.title;
+  });
+</script>

assets/css/style.scss

@@ -0,0 +1,33 @@
+---
+---
+
+@import "{{ site.theme }}";
+
+.markdown-body {
+  max-width: 800px;
+  font-size: 16px;
+}
+
+.markdown-body p {
+  font-size: 16px;
+  line-height: 1.9em;
+  margin-bottom: 1.2em;
+}
+
+.markdown-body li {
+  line-height: 1.9em;
+}
+
+input.task-list-item-checkbox {
+  margin-right: 4px;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+blockquote {
+  font-family: Constantia, "Lucida Bright", Lucidabright, "Lucida Serif", Lucida,
+    "DejaVu Serif", "Bitstream Vera Serif", "Liberation Serif", Georgia, serif;
+}

foam-tips.md

@@ -0,0 +1,3 @@
+# Foam tips
+
+_For up-to-date tips, see [Foam Recipes](https://foambubble.github.io/foam/recipes)._

inbox.md

@@ -0,0 +1,16 @@
+# Inbox
+
+- Here you can write disorganised notes to be categorised later
+- Bullet points are useful, but it could be free form text as well
+- Sometimes it's better to just get things off your mind quickly, rather than stop to think where it belongs
+- But don't let this list get too long
+- Move information to more specific documents and link to them.
+  - This helps you navigate between documents quickly
+  - For example, you can `Cmd`+`Click` this: [[todo]]
+- Some notes don't end up making sense the next day
+- That's ok, you can just delete them!
+  - You can always find them in your git history, if you really need it!
+  
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[todo]: todo "Todo"
+[//end]: # "Autogenerated link references"

readme.md

@@ -0,0 +1,44 @@
+# Foam
+
+👋 Welcome to your new Foam Workspace!
+
+## Getting started
+
+This documentation assumes that you have a GitHub account and have [Visual Studio Code](https://code.visualstudio.com/) installed on your Linux/MacOS/Windows machine.
+
+1. If you haven't yet, browse over to the main [Foam documentation workspace](https://foambubble.github.io/foam) to get an idea of what Foam is and how to use it.
+2. Press "Use this template" button at [foam-template](https://github.com/foambubble/foam-template/generate) (that's this repository!) to fork it to your own GitHub account. If you want to keep your thoughts to yourself, remember to set the repository private.
+3. [Clone the repository to your local machine](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).*
+
+4. 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](.vscode/settings.json) and edit, add or remove any settings you'd like for your Foam workspace.
+
+To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes) bubbles of the Foam documentation workspace.
+
+
+## Using Foam
+
+We've created a few Bubbles (markdown documents) to get you started.
+
+- [[inbox]] - a place to write down quick notes to be categorised later
+- [[foam-tips]] - tips to get the most out of your Foam workspace
+- [[todo]] - a place to keep track of things to do
+
+## Note on `[[wiki-links]]`
+
+⚠️ Until [foambubble/foam#16](https://github.com/foambubble/foam/issues/16) is resolved, `[[wiki-links]]` links (like the links above) won't work in the GitHub Markdown preview (i.e. this Readme on github.com).
+
+They should work as expected in VS Code, and in rendered GitHub Pages.
+
+If GitHub preview (or general 100% support with all Markdown tools) is a requirement, for the time being you can use the standard `[description](page.md)` syntax.
+
+
+
+[//begin]: # "Autogenerated link references for markdown compatibility"
+[inbox]: inbox "Inbox"
+[foam-tips]: foam-tips "Foam tips"
+[todo]: todo "Todo"
+[//end]: # "Autogenerated link references"

todo.md

@@ -0,0 +1,9 @@
+# Todo
+
+- [x] This is an example of a todo list item that's complete
+- [x] Todo lists are useful for keeping organised and focused
+- [ ] This one is not completed yet
+- [ ] You can mark it completed by pressing `Option`+`C` (or `Alt`+`C`) when your cursor is on this line
+  - [ ] You can also select multiple lines and mark them all at once!
+- [ ] When you press enter at the end of a line, it adds a new todo item on the next line
+- [ ] This, and more is provided by the [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) plugin by [Yu Zhang](https://github.com/yzhang-gh)