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
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 47 additions and 42 deletions

View file

@ -18,7 +18,7 @@ You can also write:
| ------------ | ------------- | | ------------ | ------------- |
| `/tomorrow` | tomorrow | | `/tomorrow` | tomorrow |
| `/yesterday` | yesterday | | `/yesterday` | yesterday |
| `/monday` | next monday | | `/monday` | next Monday |
| `/+1d` | tomorrow | | `/+1d` | tomorrow |
| `/-3d` | 3 days ago | | `/-3d` | 3 days ago |
| `/+1w` | in a week | | `/+1w` | in a week |
@ -31,6 +31,7 @@ You get the idea ;)
It's possible to customize path and heading of your daily notes, by following the [dateformat masking syntax](https://github.com/felixge/node-dateformat#mask-options). It's possible to customize path and heading of your daily notes, by following the [dateformat masking syntax](https://github.com/felixge/node-dateformat#mask-options).
The following properties can be used: The following properties can be used:
```json ```json
"foam.openDailyNote.directory": "journal", "foam.openDailyNote.directory": "journal",
"foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd", "foam.openDailyNote.filenameFormat": "'daily-note'-yyyy-mm-dd",
@ -39,4 +40,3 @@ The following properties can be used:
``` ```
The above configuration would create a file `journal/daily-note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`. The above configuration would create a file `journal/daily-note-2020-07-25.mdx`, with the heading `Journal Entry, Sunday, July 25`.

View file

@ -6,6 +6,7 @@ To see the graph execute the `Foam: Show Graph` command.
## Graph Navigation ## Graph Navigation
With the graph you can: With the graph you can:
- highlight a node by hovering on it, to quickly see how it's connected to the rest of your notes - highlight a node by hovering on it, to quickly see how it's connected to the rest of your notes
- select one or more (by keeping `shift` pressed while selecting) nodes by clicking on them, to better understand the structure of your notes - select one or more (by keeping `shift` pressed while selecting) nodes by clicking on them, to better understand the structure of your notes
- navigate to a note by clicking on it while pressing `ctrl` or `cmd` - navigate to a note by clicking on it while pressing `ctrl` or `cmd`
@ -13,7 +14,7 @@ With the graph you can:
## Custom Graph Styles ## Custom Graph Styles
By default the Foam graph will use the VsCode theme, but it's possible to customize it with the `foam.graph.style` setting. By default, the Foam graph will use the VS Code theme, but it's possible to customize it with the `foam.graph.style` setting.
A sample configuration object is provided below, you can provide as many or as little configuration as you wish: A sample configuration object is provided below, you can provide as many or as little configuration as you wish:
@ -35,4 +36,3 @@ A sample configuration object is provided below, you can provide as many or as l
- `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature` - `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature`
- see [[note-properties]] for details - see [[note-properties]] for details
- you can have as many types as you want - you can have as many types as you want

View file

@ -2,17 +2,20 @@
When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. When you use `[[wiki-links]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file.
This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wiki-links]]` directly. This is done to make the content of the file compatible with various Markdown tools (e.g. parsers, static site generators, VS Code plugins etc.), which don't support `[[wiki-links]]` directly.
This feature is disabled by default because you don't need it to navigate your workspace, it is useful for publishing and compatibility of your notes. This feature is disabled by default because you don't need it to navigate your workspace, it is useful for publishing and compatibility of your notes.
## Example ## Example
The following example: The following example:
```md ```md
- [[graph-visualization]] - [[graph-visualization]]
``` ```
...generates the following link reference definitions to the bottom of the file: ...generates the following link reference definitions to the bottom of the file:
```md ```md
[graph-visualization]: graph-visualization "Graph Visualization" [graph-visualization]: graph-visualization "Graph Visualization"
``` ```
@ -20,9 +23,9 @@ The following example:
## Configuration ## Configuration
You can use the `foam.edit.linkReferenceDefinitions` to configure the definitions (see [[get-started-with-vscode]]): You can use the `foam.edit.linkReferenceDefinitions` to configure the definitions (see [[get-started-with-vscode]]):
- `withoutExtensions` (default): this works better with certain web publishing tools (e.g. GitHub pages) - `withoutExtensions` (default): this works better with certain web publishing tools (e.g. GitHub pages)
- `withExtensions`: this works better with standard markdown-based tools (e.g GitHub web UI) - `withExtensions`: this works better with standard markdown-based tools (e.g GitHub web UI)
- `off`: this disables the generation of definitions - `off`: this disables the generation of definitions
After changing the setting in your workspace, you can run the `Foam: Run Janitor (Experimental)` command to convert all existing definitions. After changing the setting in your workspace, you can run the `Foam: Run Janitor (Experimental)` command to convert all existing definitions.

View file

@ -10,7 +10,8 @@ At the top of the file you can have a section where you define your properties.
> Be aware that this section needs to be at the very top of the file to be valid > Be aware that this section needs to be at the very top of the file to be valid
For example, for this file, we have: For example, for this file, we have:
```
```text
--- ---
type: feature type: feature
keywords: hello world keywords: hello world
@ -21,8 +22,9 @@ Those are properties.
Properties can be used to organize your notes. Properties can be used to organize your notes.
## Special Properties ## Special Properties
Some properties have special meaning for Foam: Some properties have special meaning for Foam:
- the `title` property will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to [[write-notes-in-foam]]) - the `title` property will assign the name to the note that you will see in the graph, regardless of the filename or the first heading (also see how to [[write-notes-in-foam]])
- the `type` property can be used to style notes differently in the graph (also see [[graph-visualization]]) - the `type` property can be used to style notes differently in the graph (also see [[graph-visualization]])
- the `tags` property can be used to add tags to a note (see [[tags-and-tag-explorer]]) - the `tags` property can be used to add tags to a note (see [[tags-and-tag-explorer]])

View file

@ -4,5 +4,4 @@ You can create notes from templates by running the `Foam: Create New Note from T
To create a template, just add regular `.md` files in `.foam/templates` (create the directory if necessary). To create a template, just add regular `.md` files in `.foam/templates` (create the directory if necessary).
Templates can use all the variables available in [VsCode Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables). Templates can use all the variables available in [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables).

View file

@ -6,11 +6,12 @@ Misspelled words are highlighted, like hellow.
You can place the cursor on top of the word, and press `cmd+.` for suggestions on how to fix the problem. You can place the cursor on top of the word, and press `cmd+.` for suggestions on how to fix the problem.
You can configure the extension in the settings, for example to: You can configure the extension in the settings, for example to:
- ignore certain files - ignore certain files
- change the language(s) - change the language(s)
- and much more - and much more
For more information go to the [Spellright extension page](https://marketplace.visualstudio.com/items?itemName=ban.spellright). For more information go to the [Spellright extension page](https://marketplace.visualstudio.com/items?itemName=ban.spellright).
There are many spell checking extensions for VsCode. There are many spell checking extensions for VS Code.
Another one of our favorites is [LTeX](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#overview), which is a bit heavier but offers some extra functionality. Another one of our favorites is [LTeX](https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex&ssr=false#overview), which is a bit heavier but offers some extra functionality.

View file

@ -9,13 +9,14 @@ tags: my-tag1 my-tag2
You can add tags to your notes to categorize them, or in any way you want. You can add tags to your notes to categorize them, or in any way you want.
There are two ways to add tags: There are two ways to add tags:
- you can add #tags just by writing them in the note - you can add #tags just by writing them in the note
- another way is through [[note-properties]], as you can see at the top of this file - another way is through [[note-properties]], as you can see at the top of this file
## Tag Explorer ## Tag Explorer
In the sidebar to the left, you will see a panel called `Tag Explorer`. In the sidebar to the left, you will see a panel called `Tag Explorer`.
You can use this panel to see the tags in your notes, and navigate them. You can use this panel to see the tags in your notes, and navigate them.
Notice `my-tag1` and `my-tag2`, which were added via [[note-properties]]. Notice `my-tag1` and `my-tag2`, which were added via [[note-properties]].

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 VS Code supports various **keyboard shortcuts**, the most important for us are:
VsCode supports various **keyboard shortcuts**, the most important for us are:
| Shortcut | Action | | 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+P` | use quickpick to open a file |
| `cmd+shift+P` | invoke a command (see below) | | `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
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. To invoke a command, press `cmd+shift+P` and select the command you want to execute.
For example, to see the Foam graph: For example, to see the Foam graph:
- press `cmd+shift+P` - press `cmd+shift+P`
- start typing `show graph` - start typing `show graph`
- select the `Foam: Show Graph` command - select the `Foam: Show Graph` command
And watch the magic unfold. 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 VS Code, check out their [website](https://code.visualstudio.com/docs#first-steps).
If you want to learn more about VsCode, check out their [website](https://code.visualstudio.com/docs#first-steps).
## Panels ## Panels
You can see a few panels on the left, including: You can see a few panels on the left, including:
- `Outline`: this panel shows you the structure of the file based on the headings - `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 - `Tag Explorer`: This shows you the tags in your workspace, see [[tags-and-tag-explorer]] for more information on tags
## Settings ## 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. 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.: 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}`: save the image next to the file
- `${currentFileDir}/images`: create an `images` directory next to the file and save the image there - `${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 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 of a note (e.g. in the [[graph-visualization]]) is given by precedence based on:
- the `title` property (see [[note-properties]]) - the `title` property (see [[note-properties]])
- the first `# heading 1` of the file - the first `# heading 1` of the file
- the file name - the file name
## Markdown Syntax ## 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. 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 # Heading 1
@ -61,8 +62,8 @@ This is a table:
| R2C1 | R2C2 | | R2C1 | R2C2 |
You can `inline code` or You can `inline code` or
```
```text
you can create you can create
code blocks code blocks
``` ```

View file

@ -6,7 +6,7 @@ Welcome to your new foam workspace, let's get you started.
Let's go through this to set up your repo: Let's go through this to set up your repo:
- [ ] if you are new with VsCode, see how to [[get-started-with-vscode]] and how to [[use-keyboard-shortcuts-for-editing]] - [ ] if you are new with VS Code, see how to [[get-started-with-vscode]] and how to [[use-keyboard-shortcuts-for-editing]]
- [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wiki link. You can go back with `ctrl+-`. Here, go to your [[inbox]] - [ ] you can navigate the links between your notes by `cmd+click` (or `ctrl+click` on Windows) on a wiki link. You can go back with `ctrl+-`. Here, go to your [[inbox]]
@ -22,11 +22,11 @@ Let's go through this to set up your repo:
- [ ] Want to see how to manage your tasks? Go to the [[todo]] note - [ ] Want to see how to manage your tasks? Go to the [[todo]] note
- [ ] The section at the end of this file contains wikilink definitions, which enable navigation of your notes from GitHub's web UI, and in general to make `[[wikilinks]]` understood by any markdown parser. See [[link-reference-definitions]]. - [ ] The section at the end of this file contains wikilink definitions, which enable navigation of your notes from GitHub's web UI, and in general to make `[[wikilinks]]` understood by any Markdown parser. See [[link-reference-definitions]].
- [ ] To explore all the Foam settings, press `cmd+,`, then `Extensions > Foam` - [ ] 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! - [ ] Living within VS Code, Foam can be customized in many ways! Look at the [Foam Recipes](https://foambubble.github.io/foam/recipes/recipes) for ideas!
- [ ] Join the [Foam community on Discord](https://foambubble.github.io/join-discord/e), introduce yourself and leave a message on how you found Foam and how the onboarding went :) We are always keen to do better - [ ] Join the [Foam community on Discord](https://foambubble.github.io/join-discord/e), introduce yourself and leave a message on how you found Foam and how the onboarding went :) We are always keen to do better
@ -41,10 +41,10 @@ Let's go through this to set up your repo:
Foam doesn't do all this magic on its own, it relies on some amazing extensions. Look at their documentation if you want to fully unlock the possibilities! Foam doesn't do all this magic on its own, it relies on some amazing extensions. Look at their documentation if you want to fully unlock the possibilities!
Here they are: Here they are:
- [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) - [Markdown All In One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one)
- [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) - [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
- [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) - [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image)
- [spellright](https://marketplace.visualstudio.com/items?itemName=ban.spellright) - [spellright](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
A special mention goes to [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links), which has now been replaced by our graph but was foundational to Foam's beginnings. A special mention goes to [Markdown Links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links), which has now been replaced by our graph but was foundational to Foam's beginnings.

View file

@ -10,4 +10,3 @@
- Some notes don't end up making sense the next day - Some notes don't end up making sense the next day
- That's ok, you can just delete them! - That's ok, you can just delete them!
- You can always find them in your git history, if you really need it! - You can always find them in your git history, if you really need it!

View file

@ -6,7 +6,7 @@
## Getting started ## 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. 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](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. 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.
@ -20,11 +20,11 @@ After setting up the repository, head to [[getting-started]] to get familiar wit
To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace. To learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace.
And remember that you can always join our [Foam community on Discord](https://foambubble.github.io/join-discord/g)! And remember that you can always join our [Foam community on Discord](https://foambubble.github.io/join-discord/g)!
## Using Foam ## Using Foam
We've created a few Bubbles (markdown documents) to get you started. We've created a few Bubbles (Markdown documents) to get you started.
- [[inbox]] - a place to write down quick notes to be categorized later - [[inbox]] - a place to write down quick notes to be categorized later
- [[getting-started]] - learn how to use your Foam workspace - [[getting-started]] - learn how to use your Foam workspace
@ -32,7 +32,6 @@ We've created a few Bubbles (markdown documents) to get you started.
In the `docs` directory you can find everything you need to learn the basics of Foam. In the `docs` directory you can find everything you need to learn the basics of Foam.
[//begin]: # "Autogenerated link references for markdown compatibility" [//begin]: # "Autogenerated link references for markdown compatibility"
[getting-started]: getting-started.md "Getting Started" [getting-started]: getting-started.md "Getting Started"
[inbox]: inbox.md "Inbox" [inbox]: inbox.md "Inbox"

View file

@ -6,4 +6,3 @@ You can create todos in Foam.
- [ ] This one is not completed yet - [ ] 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 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! - [ ] You can also select multiple lines and mark them all at once!