Initial commit

This commit is contained in:
Aly 2020-10-31 11:58:52 -07:00
parent b6ec501cf1
commit ddbd8bdab7
6 changed files with 13 additions and 70 deletions

View file

@ -3,7 +3,7 @@
"editor.wrappingIndent": "indent",
"editor.overviewRulerBorder": false,
"editor.lineHeight": 24,
"workbench.colorTheme": "Gray Matter Light",
"workbench.colorTheme": "Nord",
"[markdown]": {
"editor.quickSuggestions": true
},

View file

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

View file

@ -1,16 +0,0 @@
# 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"

7
journal/2020-10-31.md Normal file
View file

@ -0,0 +1,7 @@
# 2020-10-31
- Set up this journal. See the [[readme]].
[//begin]: # "Autogenerated link references for markdown compatibility"
[readme]: ..\README "Aly's digital garden"
[//end]: # "Autogenerated link references"

View file

@ -1,44 +1,5 @@
# Foam
# Aly's digital garden
👋 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"
This garden is part of an experiment on what being part of a shared digital
knowledge base entails. See the [Agora](https://flancia.org/go/agora) for more
details.

View file

@ -1,9 +1,3 @@
# 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)
- [ ] Add this garden to the [Agora](https://flancia.org/go/agora)