Rudimentary template

This commit is contained in:
Jani Eväkallio 2020-06-20 02:24:45 +01:00
parent bf6658019d
commit 6b34fb4ce8
7 changed files with 71 additions and 2 deletions

11
.vscode/extensions.json vendored Normal file
View File

@ -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"
]
}

9
.vscode/settings.json vendored Normal file
View File

@ -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"
}

View File

@ -1,2 +0,0 @@
# foam-template
Foam workpace template

22
foam_tips.md Normal file
View File

@ -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

12
inbox.md Normal file
View File

@ -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!

10
readme.md Normal file
View File

@ -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.

7
todo.md Normal file
View File

@ -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