From 6b34fb4ce83ccc0586d00aa1d0535593ce2d4155 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jani=20Ev=C3=A4kallio?= Date: Sat, 20 Jun 2020 02:24:45 +0100 Subject: [PATCH] Rudimentary template --- .vscode/extensions.json | 11 +++++++++++ .vscode/settings.json | 9 +++++++++ README.md | 2 -- foam_tips.md | 22 ++++++++++++++++++++++ inbox.md | 12 ++++++++++++ readme.md | 10 ++++++++++ todo.md | 7 +++++++ 7 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 .vscode/extensions.json create mode 100644 .vscode/settings.json delete mode 100644 README.md create mode 100644 foam_tips.md create mode 100644 inbox.md create mode 100644 readme.md create mode 100644 todo.md diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..d8acb0c --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,11 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "esbenp.prettier-vscode", + "eamodio.gitlens", + "ivangabriele.vscode-git-add-and-commit", + "philipbe.theme-gray-matter", + "yzhang.markdown-all-in-one" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..75466da --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "editor.minimap.enabled": false, + "editor.fontLigatures": true, + "editor.wrappingIndent": "indent", + "editor.overviewRulerBorder": false, + "editor.lineHeight": 24, + "workbench.colorTheme": "Gray Matter Light", + "cSpell.language": "en-GB" +} diff --git a/README.md b/README.md deleted file mode 100644 index 0ba536c..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# foam-template -Foam workpace template diff --git a/foam_tips.md b/foam_tips.md new file mode 100644 index 0000000..801137e --- /dev/null +++ b/foam_tips.md @@ -0,0 +1,22 @@ +## Foam tips + +_For up-to-date tips, see [Foam Recipes](https://foambubble.github.io/foam/recipes)._ + +## Structuring content + +**Foam** is a tool that supports creating relationships between thoughts and information to help you think better. + +Whether you want to build a [Second Brain](https://www.buildingasecondbrain.com/) or a [Zettelkasten](https://zettelkasten.de/posts/overview/), or you want to [GTD](https://gettingthingsdone.com/what-is-gtd/) or just go with the flow, **Foam** can help you organise your thoughts if you follow these simple rules: + +1. Consider this **Foam** a workspace for all your knowledge and research. +2. Write your thoughts in markdown documents (I like to call them **Bubbles**, but that might be more than a little twee). These documents should be atomic: Put things that belong together into a single document, and limit its content to that single topic. ([source](https://zettelkasten.de/posts/overview/#principles)) +3. Use Foam's shortcuts and autocompletions to link your thoughts together with Markdown links, and navigate between to explore your knowledge graph. + + +## Useful commands + +TODO + +## Keyboard shortcuts + +TODO \ No newline at end of file diff --git a/inbox.md b/inbox.md new file mode 100644 index 0000000..8cf08d8 --- /dev/null +++ b/inbox.md @@ -0,0 +1,12 @@ +## 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](todo.md) +- 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! \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..efb8a6e --- /dev/null +++ b/readme.md @@ -0,0 +1,10 @@ +# Foam + +Welcome to your Foam. We've created a few Bubbles (markdown documents) for you. Feel free to use them or delete them. + +Your Foam, your rules. + +- [Inbox](inbox.md) - a place to write down quick notes to be categorised later +- [Todo](todo.md) - a todo list +- [Foam tips](foam_tips.md) - tips to get the most out of your foam. + diff --git a/todo.md b/todo.md new file mode 100644 index 0000000..d18e29f --- /dev/null +++ b/todo.md @@ -0,0 +1,7 @@ +# Todo + +- [x] This is an example of a todo list item that's complete +- [ ] 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 +- [ ] When you press enter at the end of a line, it adds a new todo item on the next line \ No newline at end of file