Added onboarding and major changes to template (#28)
* removed gitlens * adjusted various settings * added foam onboarding to template * removed prettier extension * added setting to match OS color scheme * a couple of minor changes re todos and readme * added spellright to list of recommended extensions, and added to getting started guide * added reference to LTeX in spell checking doc * Added logo to readme * fixed link to LTeX extension * styling logo in readme * more style experiments
This commit is contained in:
Riccardo
46
docs/how-to/get-started-with-vscode.md
Normal file
46
docs/how-to/get-started-with-vscode.md
Normal file
@ -0,0 +1,46 @@
|
||||
# Getting started with VsCode
|
||||
|
||||
VsCode is an powerful text editor, hidden behind a simple interface.
|
||||
|
||||
## Keyboard shortcuts
|
||||
VsCode supports various **keyboard shortcuts**, the most important for us are:
|
||||
|
||||
| Shortcut | Action |
|
||||
| ------------- | ---------------------------- |
|
||||
| `cmd+N` | create a new file |
|
||||
| `cmd+S` | save the current file |
|
||||
| `cmd+O` | open a file |
|
||||
| `cmd+P` | use quickpick to open a file |
|
||||
| `cmd+shift+P` | invoke a command (see below) |
|
||||
|
||||
For more information, see the [vscode keyboard cheat sheets](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference), where you can also see how to customize your keybindings.
|
||||
|
||||
## Commands
|
||||
Commands make VsCode extremely powerful.
|
||||
|
||||
To invoke a command, press `cmd+shift+P` and select the command you want to execute.
|
||||
For example, to see the Foam graph:
|
||||
- press `cmd+shift+P`
|
||||
- start typing `show graph`
|
||||
- select the `Foam: Show Graph` command
|
||||
|
||||
And watch the magic unfold.
|
||||
|
||||
For more information on commands, see [commands on the VsCode site](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
|
||||
|
||||
|
||||
If you want to learn more about VsCode, check out their [website](https://code.visualstudio.com/docs#first-steps).
|
||||
|
||||
## Panels
|
||||
|
||||
You can see a few panels on the left, including:
|
||||
- `Outline`: this panel shows you the structure of the file based on the headings
|
||||
- `Tag Explorer`: This shows you the tags in your workspace, see [[tags-and-tag-explorer]] for more information on tags
|
||||
|
||||
## Settings
|
||||
|
||||
To view or change the settings in VsCode, press `cmd+,`
|
||||
|
||||
[//begin]: # "Autogenerated link references for markdown compatibility"
|
||||
[tags-and-tag-explorer]: ../features/tags-and-tag-explorer.md "Tags and Tag Explorer"
|
||||
[//end]: # "Autogenerated link references"
|
||||
13
docs/how-to/paste-images-from-clipboard.md
Normal file
13
docs/how-to/paste-images-from-clipboard.md
Normal file
@ -0,0 +1,13 @@
|
||||
# Paste Images from Clipboard
|
||||
|
||||
You can paste an image from the clipboard with `cmd+alt+v`.
|
||||
|
||||
Images are automatically copied to the `/attachments` folder and a reference is added in the file where you pasted them.
|
||||
|
||||
A prompt will ask you to confirm the name of the image, to disable it set `"pasteImage.showFilePathConfirmInputBox": false,` in the settings.
|
||||
|
||||
To change the location where the image is created, change the `pasteImage.path` property, e.g.:
|
||||
- `${currentFileDir}`: save the image next to the file
|
||||
- `${currentFileDir}/images`: create an `images` directory next to the file and save the image there
|
||||
|
||||
For more info check the [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) extension page.
|
||||
43
docs/how-to/use-keyboard-shortcuts-for-editing.md
Normal file
43
docs/how-to/use-keyboard-shortcuts-for-editing.md
Normal file
@ -0,0 +1,43 @@
|
||||
# Use Keyboard Shortcuts for Editing
|
||||
|
||||
Here are some keyboard shortcuts you'll love when editing your notes.
|
||||
|
||||
This works best if you can see the result in the preview panel, run the `Markdown: Open Preview to the Side` command.
|
||||
|
||||
- [ ] `alt+c` changes state to a TODO item. Try it while the cursor is on this line.
|
||||
|
||||
---
|
||||
|
||||
- [ ] `cmd+b` makes the selection bold. Select me and make me bold.
|
||||
|
||||
---
|
||||
|
||||
- [ ] `cmd+i` makes the selection italic. Select me and make me italic.
|
||||
|
||||
---
|
||||
|
||||
- [ ] `alt+shift+f` formats a table. Place the cursor in the table below and format the table.
|
||||
|
||||
| column 1 | column 2|
|
||||
|-|-|
|
||||
| one element | another element|
|
||||
| second row| last cell|
|
||||
|
||||
---
|
||||
|
||||
- [ ] Paste link on selected text
|
||||
1. copy the following text: https://google.com
|
||||
2. select me and paste
|
||||
|
||||
---
|
||||
|
||||
- [ ] Search in your repo with `cmd+shift+f`: type "search"
|
||||
- (go back to the file explorer with `cmd+shift+e`)
|
||||
|
||||
---
|
||||
|
||||
- [ ] Paste an image
|
||||
1. copy an image
|
||||
2. move your cursor to the next line, then press `cmd+alt+v` and confirm the name of the file
|
||||
3. .
|
||||
4. the image file has been created in `/attachments` and a reference to it has been added here
|
||||
73
docs/how-to/write-notes-in-foam.md
Normal file
73
docs/how-to/write-notes-in-foam.md
Normal file
@ -0,0 +1,73 @@
|
||||
# Writing Notes
|
||||
|
||||
Notes are simple text files with some extra flavor, in the shape of Markdown syntax and support for extra properties (see [[note-properties]]).
|
||||
|
||||
## Foam Syntax
|
||||
|
||||
Foam uses standard markdown, with a few added twists:
|
||||
- the title of a note (e.g. in the [[graph-visualization]]) is given by precedence based on:
|
||||
- the `title` property (see [[note-properties]])
|
||||
- the first `# heading 1` of the file
|
||||
- the file name
|
||||
|
||||
|
||||
## Markdown Syntax
|
||||
With markdown we can style our notes in a simple way, while keeping the document a simple text file (the best way to future-proof your writings!).
|
||||
|
||||
You can see the formatted output by running the `Markdown: Open Preview to the Side` command.
|
||||
|
||||
Here is a high level overview of Markdown, for more information on the markdown syntax [see here](https://commonmark.org/help/).
|
||||
|
||||
# Heading 1
|
||||
|
||||
## Heading 2
|
||||
|
||||
### Heading 3
|
||||
|
||||
#### Heading 4
|
||||
|
||||
##### Heading 5
|
||||
|
||||
###### Heading 6
|
||||
|
||||
This is a [link to google](https://www.google.com).
|
||||
|
||||
This is a wiki link (aka internal link) to [[note-properties]].
|
||||
|
||||
Here is an image:
|
||||
|
||||
|
||||
> this is a blockquote
|
||||
> it can span multiple lines
|
||||
|
||||
- list item
|
||||
- list item
|
||||
- list item
|
||||
|
||||
1. One
|
||||
2. Two
|
||||
3. Three
|
||||
|
||||
This text is **in bold** and this is *italic*.
|
||||
|
||||
The following is a horizontal rule
|
||||
|
||||
---
|
||||
|
||||
This is a table:
|
||||
| Column 1 | Column 2 |
|
||||
| -------- | -------- |
|
||||
| R1C1 | R1C2 |
|
||||
| R2C1 | R2C2 |
|
||||
|
||||
You can `inline code` or
|
||||
```
|
||||
you can create
|
||||
code blocks
|
||||
```
|
||||
|
||||
|
||||
[//begin]: # "Autogenerated link references for markdown compatibility"
|
||||
[note-properties]: ../features/note-properties.md "Note Properties"
|
||||
[graph-visualization]: ../features/graph-visualization.md "Graph Visualization"
|
||||
[//end]: # "Autogenerated link references"
|
||||
Reference in New Issue
Block a user