Fix linting errors, spelling typos, and punctuations for all .md files (#40)

This commit is contained in:
Prashanth Subrahmanyam
2021-09-06 02:16:59 +05:30
committed by GitHub
parent e64b0d9961
commit 719ed27be6
14 changed files with 47 additions and 42 deletions

View File

@ -1,9 +1,8 @@
# Getting started with VsCode
# Getting started with VS Code
VsCode is a powerful text editor, hidden behind a simple interface.
VS Code is a powerful text editor, hidden behind a simple interface.
## Keyboard shortcuts
VsCode supports various **keyboard shortcuts**, the most important for us are:
VS Code supports various **keyboard shortcuts**, the most important for us are:
| Shortcut | Action |
| ------------- | ---------------------------- |
@ -13,31 +12,32 @@ VsCode supports various **keyboard shortcuts**, the most important for us are:
| `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.
For more information, see the [VS Code 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.
Commands make VS Code 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).
For more information on commands, see [commands on the VS Code 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).
If you want to learn more about VS Code, 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+,`
To view or change the settings in VS Code, press `cmd+,`

View File

@ -4,9 +4,10 @@ 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.
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

View File

@ -4,19 +4,20 @@ Notes are simple text files with some extra flavor, in the shape of Markdown syn
## Foam Syntax
Foam uses standard markdown, with a few added twists:
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 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!).
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/).
Here is a high level overview of Markdown, for more information on the Markdown syntax [see here](https://commonmark.org/help/).
# Heading 1
@ -61,8 +62,8 @@ This is a table:
| R2C1 | R2C2 |
You can `inline code` or
```
```text
you can create
code blocks
```