Fix linting errors, spelling typos, and punctuations for all .md files (#40)
This commit is contained in:
committed by
GitHub
parent
e64b0d9961
commit
719ed27be6
@ -18,7 +18,7 @@ You can also write:
|
||||
| ------------ | ------------- |
|
||||
| `/tomorrow` | tomorrow |
|
||||
| `/yesterday` | yesterday |
|
||||
| `/monday` | next monday |
|
||||
| `/monday` | next Monday |
|
||||
| `/+1d` | tomorrow |
|
||||
| `/-3d` | 3 days ago |
|
||||
| `/+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).
|
||||
The following properties can be used:
|
||||
|
||||
```json
|
||||
"foam.openDailyNote.directory": "journal",
|
||||
"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`.
|
||||
|
||||
|
||||
@ -6,6 +6,7 @@ To see the graph execute the `Foam: Show Graph` command.
|
||||
## Graph Navigation
|
||||
|
||||
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
|
||||
- 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`
|
||||
@ -13,7 +14,7 @@ With the graph you can:
|
||||
|
||||
## 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:
|
||||
|
||||
@ -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`
|
||||
- see [[note-properties]] for details
|
||||
- you can have as many types as you want
|
||||
|
||||
|
||||
@ -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.
|
||||
|
||||
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.
|
||||
|
||||
## Example
|
||||
|
||||
The following example:
|
||||
|
||||
```md
|
||||
- [[graph-visualization]]
|
||||
```
|
||||
|
||||
...generates the following link reference definitions to the bottom of the file:
|
||||
|
||||
```md
|
||||
[graph-visualization]: graph-visualization "Graph Visualization"
|
||||
```
|
||||
@ -20,9 +23,9 @@ The following example:
|
||||
## Configuration
|
||||
|
||||
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)
|
||||
- `withExtensions`: this works better with standard markdown-based tools (e.g GitHub web UI)
|
||||
- `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.
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
For example, for this file, we have:
|
||||
```
|
||||
|
||||
```text
|
||||
---
|
||||
type: feature
|
||||
keywords: hello world
|
||||
@ -21,8 +22,9 @@ Those are properties.
|
||||
Properties can be used to organize your notes.
|
||||
|
||||
## Special Properties
|
||||
|
||||
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 `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]])
|
||||
|
||||
|
||||
@ -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).
|
||||
|
||||
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).
|
||||
|
||||
@ -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 configure the extension in the settings, for example to:
|
||||
|
||||
- ignore certain files
|
||||
- change the language(s)
|
||||
- and much more
|
||||
|
||||
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.
|
||||
|
||||
@ -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.
|
||||
|
||||
There are two ways to add tags:
|
||||
|
||||
- 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
|
||||
|
||||
## 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.
|
||||
|
||||
Notice `my-tag1` and `my-tag2`, which were added via [[note-properties]].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user