From cb52fbef67b4cbfbe33291f8cca749e14aab67b6 Mon Sep 17 00:00:00 2001 From: Riccardo Ferretti Date: Tue, 5 Jan 2021 23:30:47 +0100 Subject: [PATCH] added a getting started guide, and some settings defaults --- .vscode/settings.json | 5 +++-- foam-tips.md | 3 --- getting-started.md | 32 ++++++++++++++++++++++++++++++++ inbox.md | 4 ++-- readme.md | 12 ++++++------ 5 files changed, 43 insertions(+), 13 deletions(-) delete mode 100644 foam-tips.md create mode 100644 getting-started.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 35821d6..920f73b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,7 +3,6 @@ "editor.wrappingIndent": "indent", "editor.overviewRulerBorder": false, "editor.lineHeight": 24, - "workbench.colorTheme": "Gray Matter Light", "[markdown]": { "editor.quickSuggestions": true }, @@ -18,5 +17,7 @@ }, "vscodeMarkdownNotes.noteCompletionConvention": "noExtension", "vscodeMarkdownNotes.slugifyMethod": "github-slugger", - "foam.edit.linkReferenceDefinitions": "withExtensions" + "foam.edit.linkReferenceDefinitions": "withExtensions", + "foam.openDailyNote.directory": "journal", + "foam.openDailyNote.titleFormat": "fullDate", } diff --git a/foam-tips.md b/foam-tips.md deleted file mode 100644 index bd934b7..0000000 --- a/foam-tips.md +++ /dev/null @@ -1,3 +0,0 @@ -# Foam tips - -_For up-to-date tips, see [Foam Recipes](https://foambubble.github.io/foam/recipes/recipes)._ diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..e98a287 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,32 @@ +# Getting Started + +Welcome to your new foam workspace, let's get you started. + +Let's go through this to set up your repo: + +- [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wikilink. Here, go to your [[inbox]] + +- [ ] to see how your notes are connected, execute the `Foam: Show Graph` command + - **tip** - `cmd+click` on a node to navigate to it + - **tip** - keep the graph open. As you navigate your files, it will focus on the active note, so you can at a glance see how it's connected in your knowledge base + +- [ ] #tags can be used to further organize your content. Look at the `Tag Explorer` view on the left panel to find and navigate the tags in your knowledge base + +- [ ] You can use Foam for your daily notes, or journaling. Execute now the `Foam: Open Daily Note` command to create a new file in your `journal` folder. + - **tip** - you can customize location, filename and note title for you daily notes in the settings + +- [ ] The section at the end of this file contains [wikilink definitions](https://foambubble.github.io/foam/features/link-reference-definitions), which enable navigation of your notes from GitHub's web UI, and in general to make `[[wikilinks]]` understood by any markdown parser. + - **tip** - Foam will sync links and definitions whenever you save the file + - **tip** - If you are just using foam in VsCode you can turn off wikilink definitions in your VsCode settings + +- [ ] Want to see how to manage your tasks? Go to the [[todo]] note + +- [ ] To explore all the Foam settings, press `cmd+,`, then `Extensions > Foam` + +- [ ] Living within VsCode, Foam can be customized in many ways! Look at the [Foam Recipes](https://foambubble.github.io/foam/recipes/recipes) for ideas! + + +[//begin]: # "Autogenerated link references for markdown compatibility" +[inbox]: inbox.md "Inbox" +[todo]: todo.md "Todo" +[//end]: # "Autogenerated link references" diff --git a/inbox.md b/inbox.md index f52a4c6..7ec1963 100644 --- a/inbox.md +++ b/inbox.md @@ -10,7 +10,7 @@ - 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.md "Todo" +[todo]: todo "Todo" [//end]: # "Autogenerated link references" diff --git a/readme.md b/readme.md index 9e137d6..9aacc6b 100644 --- a/readme.md +++ b/readme.md @@ -1,20 +1,20 @@ # Foam -👋 Welcome to your new Foam Workspace! +👋 Welcome to your new Foam Knowledge Base! ## 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. +1. If you haven't yet, browse over to the main [Foam documentation](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).* + *Open the repository as a folder using the `File > Open...` menu item.* 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. +After setting up the repository, head to [[getting-started]] to get familiar with your new knowledge base! To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace. @@ -24,13 +24,13 @@ To learn more about how to use **Foam**, read the [Recipes](https://foambubble.g 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 +- [[getting-started]] - learn how to use your Foam workspace - [[todo]] - a place to keep track of things to do [//begin]: # "Autogenerated link references for markdown compatibility" +[getting-started]: getting-started.md "Getting Started" [inbox]: inbox.md "Inbox" -[foam-tips]: foam-tips.md "Foam tips" [todo]: todo.md "Todo" [//end]: # "Autogenerated link references"