From cc84862e0094d696b6921a22e786e6b55b4dcbf6 Mon Sep 17 00:00:00 2001 From: Nicholas Stafie <10801854+nstafie@users.noreply.github.com> Date: Fri, 10 Jul 2020 15:17:10 +0100 Subject: [PATCH 1/2] Clarify how the repository should be opened in VS Code --- readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 9d04972..231dab8 100644 --- a/readme.md +++ b/readme.md @@ -9,6 +9,9 @@ This documentation assumes that you have a GitHub account and have [Visual Studi 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. In VS Code, opening a 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. @@ -26,7 +29,7 @@ We've created a few Bubbles (markdown documents) to get you started. ## 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). +⚠️ 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. From 07767bdb98418444dd605d99c4becd1d37bda101 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jani=20Ev=C3=A4kallio?= Date: Wed, 15 Jul 2020 21:25:33 +0100 Subject: [PATCH 2/2] Fixup language --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 231dab8..2be58cc 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,7 @@ This documentation assumes that you have a GitHub account and have [Visual Studi 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. In VS Code, opening a 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. 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)