From 719ed27be601891f7d25e6e6ab815c18832c2e3f Mon Sep 17 00:00:00 2001 From: Prashanth Subrahmanyam Date: Mon, 6 Sep 2021 02:16:59 +0530 Subject: [PATCH] Fix linting errors, spelling typos, and punctuations for all .md files (#40) --- docs/features/daily-notes.md | 4 ++-- docs/features/graph-visualization.md | 4 ++-- docs/features/link-reference-definitions.md | 7 +++++-- docs/features/note-properties.md | 6 ++++-- docs/features/note-templates.md | 3 +-- docs/features/spell-checking.md | 3 ++- docs/features/tags-and-tag-explorer.md | 3 ++- docs/how-to/get-started-with-vscode.md | 22 ++++++++++----------- docs/how-to/paste-images-from-clipboard.md | 3 ++- docs/how-to/write-notes-in-foam.md | 15 +++++++------- getting-started.md | 8 ++++---- inbox.md | 1 - readme.md | 9 ++++----- todo.md | 1 - 14 files changed, 47 insertions(+), 42 deletions(-) diff --git a/docs/features/daily-notes.md b/docs/features/daily-notes.md index 6635b7b..f089cd9 100644 --- a/docs/features/daily-notes.md +++ b/docs/features/daily-notes.md @@ -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`. - diff --git a/docs/features/graph-visualization.md b/docs/features/graph-visualization.md index d01f3b2..85103ff 100644 --- a/docs/features/graph-visualization.md +++ b/docs/features/graph-visualization.md @@ -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 - diff --git a/docs/features/link-reference-definitions.md b/docs/features/link-reference-definitions.md index 57a454b..84a0ac5 100644 --- a/docs/features/link-reference-definitions.md +++ b/docs/features/link-reference-definitions.md @@ -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. - diff --git a/docs/features/note-properties.md b/docs/features/note-properties.md index 597f990..d65da71 100644 --- a/docs/features/note-properties.md +++ b/docs/features/note-properties.md @@ -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]]) - diff --git a/docs/features/note-templates.md b/docs/features/note-templates.md index 17b1fa9..37c85d5 100644 --- a/docs/features/note-templates.md +++ b/docs/features/note-templates.md @@ -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). diff --git a/docs/features/spell-checking.md b/docs/features/spell-checking.md index 332a431..7fd08b0 100644 --- a/docs/features/spell-checking.md +++ b/docs/features/spell-checking.md @@ -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. diff --git a/docs/features/tags-and-tag-explorer.md b/docs/features/tags-and-tag-explorer.md index 661a2e2..ea9bfb0 100644 --- a/docs/features/tags-and-tag-explorer.md +++ b/docs/features/tags-and-tag-explorer.md @@ -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]]. - diff --git a/docs/how-to/get-started-with-vscode.md b/docs/how-to/get-started-with-vscode.md index 3861584..859e4f7 100644 --- a/docs/how-to/get-started-with-vscode.md +++ b/docs/how-to/get-started-with-vscode.md @@ -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+,` diff --git a/docs/how-to/paste-images-from-clipboard.md b/docs/how-to/paste-images-from-clipboard.md index 5aa55bf..759c17b 100644 --- a/docs/how-to/paste-images-from-clipboard.md +++ b/docs/how-to/paste-images-from-clipboard.md @@ -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 diff --git a/docs/how-to/write-notes-in-foam.md b/docs/how-to/write-notes-in-foam.md index acbb9ab..d111bab 100644 --- a/docs/how-to/write-notes-in-foam.md +++ b/docs/how-to/write-notes-in-foam.md @@ -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 ``` - diff --git a/getting-started.md b/getting-started.md index 9182ce7..c06581d 100644 --- a/getting-started.md +++ b/getting-started.md @@ -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: -- [ ] 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]] @@ -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 -- [ ] 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` -- [ ] 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 @@ -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! Here they are: + - [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) - [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) - [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. - diff --git a/inbox.md b/inbox.md index 7231cf7..275b39f 100644 --- a/inbox.md +++ b/inbox.md @@ -10,4 +10,3 @@ - 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! - diff --git a/readme.md b/readme.md index 1509310..480b6e0 100644 --- a/readme.md +++ b/readme.md @@ -6,7 +6,7 @@ ## 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. 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. -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 -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 - [[getting-started]] - learn how to use your Foam workspace @@ -32,14 +32,13 @@ 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. - [//begin]: # "Autogenerated link references for markdown compatibility" [getting-started]: getting-started.md "Getting Started" [inbox]: inbox.md "Inbox" [todo]: todo.md "Todo" [//end]: # "Autogenerated link references" -## Submitting Issues +## Submitting Issues As you may have noticed, issues are disabled. With the goal to keep the project fairly easy to maintain, please file your issues in the main Foam repository: diff --git a/todo.md b/todo.md index d0f6435..f71a016 100644 --- a/todo.md +++ b/todo.md @@ -6,4 +6,3 @@ You can create todos in Foam. - [ ] 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! -