Docs sync @ 571b6a3 Add FOAM_TITLE_SAFE variable (#1232) (#50)

docs/features/commands.md

@@ -2,7 +2,7 @@
 
 Foam has various commands that you can explore by calling the command palette and typing "Foam".
 
-In particular, some commands can be very customizible and can help with custom workflows and use cases.
+In particular, some commands can be very customizable and can help with custom workflows and use cases.
 
 ## foam-vscode.create-note command
 

docs/features/graph-visualization.md

@@ -62,7 +62,7 @@ It is possible to customize the style of a node based on the `type` property in
 
 There are a few default node types defined by Foam that are displayed in the graph:
 
-- `note` defines the color for regular nodes whose documents have not overriden the `type` property.
+- `note` defines the color for regular nodes whose documents have not overridden the `type` property.
 - `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists.
   - see [[wikilinks]] for more info <!--NOTE: this placeholder link should NOT have an associated file. This is to demonstrate the custom coloring-->
 - `tag` defines the color for nodes representing #tags, allowing tags to be used as graph nodes similar to backlinks.

docs/features/including-notes.md

@@ -4,7 +4,7 @@ In some situations it might be useful to include the content of another note in
 
 ## Including a note
 
-Including a note can be done by adding an `!` before a wikilink defintion. For example `![[wikilink]]`.
+Including a note can be done by adding an `!` before a wikilink definition. For example `![[wikilink]]`.
 
 ## Custom styling
 

docs/features/link-reference-definitions.md

@@ -19,6 +19,7 @@ The following example:
   ```
 
 You can open the [raw markdown](https://foambubble.github.io/foam/features/link-reference-definitions.md) to see them at the bottom of this file
+You can open the [raw markdown](https://foambubble.github.io/foam/user/features/link-reference-definitions.md) to see them at the bottom of this file
 
 ## Specification
 

docs/features/note-properties.md

@@ -19,7 +19,7 @@ keywords: hello world, bonjour
 ---
 ```
 
-This sets the `type` of this document to `feature` and sets **three** keywords for the document: `hello`, `world`, and `bonjour`. The YAML parser will treat both spaces and commas as the seperators for these YAML properties. If you want to use multi-word values for these properties, you will need to combine the words with dashes or underscores (i.e. instead of `hello world`, use `hello_world` or `hello-world`).
+This sets the `type` of this document to `feature` and sets **three** keywords for the document: `hello`, `world`, and `bonjour`. The YAML parser will treat both spaces and commas as the separators for these YAML properties. If you want to use multi-word values for these properties, you will need to combine the words with dashes or underscores (i.e. instead of `hello world`, use `hello_world` or `hello-world`).
 
 > You can set as many custom properties for a document as you like, but there are a few [special properties](#special-properties) defined by Foam.
 
@@ -28,7 +28,7 @@ This sets the `type` of this document to `feature` and sets **three** keywords f
 Some properties have special meaning for Foam:
 
 | Name    | Description                                                                                                                                                                      |
-| -------------------- | ------------------- |
+| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `title` | 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]])                       |
 | `type`  | can be used to style notes differently in the graph (also see [[graph-visualization]]). The default type for a document is `note` unless otherwise specified with this property. |
 | `tags`  | can be used to add tags to a note (see [[tags]])                                                                                                                                 |

docs/features/note-templates.md

@@ -58,6 +58,7 @@ In addition, you can also use variables provided by Foam:
 | -------------------- | ------------ |
 | `FOAM_SELECTED_TEXT` | Foam will fill it with selected text when creating a new note, if any text is selected. Selected text will be replaced with a wikilink to the new     |
 | `FOAM_TITLE`         | The title of the note. If used, Foam will prompt you to enter a title for the note.        |
+| `FOAM_TITLE_SAFE`    | The title of the note in a file system safe format. If used, Foam will prompt you to enter a title for the note unless `FOAM_TITLE` has already caused the prompt.   |
 | `FOAM_SLUG`          | The sluggified title of the note (using the default github slug method). If used, Foam will prompt you to enter a title for the note unless `FOAM_TITLE` has already caused the prompt.   |
 | `FOAM_DATE_*`        | `FOAM_DATE_YEAR`, `FOAM_DATE_MONTH`, `FOAM_DATE_WEEK` etc. Foam-specific versions of [VS Code's datetime snippet variables](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_variables). Prefer these versions over VS Code's. |
 

docs/features/tags.md

@@ -15,6 +15,10 @@ There are two ways of creating a tag:
 
 Tags can also be hierarchical, so you can have `#parent/child` such as #my-tag3/info.
 
+### Tag completion
+
+Typing the `#` character will launch VS Code's "Intellisense." This provider will show a list of possible tags that match the character. If you are editing in the frontmatter [[note-properties|note property]], you can invoke tag completion on the `tags:` line by either typing the `#` character, or using the ["trigger suggest"](https://code.visualstudio.com/docs/editor/intellisense) keybinding (usually `ctrl+space`). If the `#` is used in the frontmatter, it will be removed when the tag is inserted.
+
 ## Using *Tag Explorer*
 
 It's possible to navigate tags via the Tag Explorer panel. Expand the Tag Explorer view in the left side bar which will list all the tags found in current Foam environment. Then, each level of tags can be expanded until the options to search by tag and a list of all files containing a particular tag are shown.
@@ -33,7 +37,7 @@ It is possible to customize the way that tags look in the Markdown Preview panel
 
 > Note: the file path for the stylesheet will be relative to the currently open folder in the workspace when changing this setting for the current workspace. If changing this setting for the user, then the file path will be relative to your global [VSCode settings](https://code.visualstudio.com/docs/getstarted/settings).
 
-The end result will be a CSS file that looks similiar to the content below. Now you can make your tags standout in your note previews.
+The end result will be a CSS file that looks similar to the content below. Now you can make your tags standout in your note previews.
 
 ```css
 .foam-tag{
@@ -49,3 +53,6 @@ The end result will be a CSS file that looks similiar to the content below. Now
 Given the power of backlinks, some people prefer to use them as tags.
 For example you can tag your notes about books with [[book]].
 
+[note-properties|note property]: note-properties.md "Note Properties"
+[graph-visualization]: graph-visualization.md "Graph Visualization"
+

docs/index.md

@@ -14,7 +14,7 @@ strategies for getting the most out of Foam. The full docs are included in the
 - [[recommended-extensions]]
 - [[creating-new-notes]]
 - [[write-notes-in-foam]]
-- [[sync-notes-with-soruce-control]]
+- [[sync-notes-with-source-control]]
 - [[keyboard-shortcuts]]
 
 ## Features

docs/publishing/math-support-with-katex.md

@@ -50,5 +50,5 @@ In our case, we'll be using the latter tag to wrap our {% raw %}`{{ content }}`{
 
 You may have noticed that we only made modifications to the template `_layouts/page.html`, which means that `_layouts/home.html` won't have KaTeX support. If you wan't to render math in Foam's home page, you'll need to make the same modifications to `_layouts/home.html` as well.
 
-Finally, if all goes well, then our site hosted on Vercel will support rendering math equations with KaTeX after commiting these changes to GitHub. Here's a demo of the default template with KaTeX support: [Foam Template with KaTeX support](https://foam-template.vercel.app/).
+Finally, if all goes well, then our site hosted on Vercel will support rendering math equations with KaTeX after committing these changes to GitHub. Here's a demo of the default template with KaTeX support: [Foam Template with KaTeX support](https://foam-template.vercel.app/).
 

docs/publishing/publish-to-vercel.md

@@ -65,7 +65,7 @@ gem "jekyll-katex"  # Optional, the package that enables KaTeX math rendering
 
 Besides adding the plugin `jekyll-katex` in `_config.yml` and `Gemfile`, we'll also have to follow the guides in [[math-support-with-katex]] to let our site fully support using KaTeX to render math equations.
 
-### Commiting changes to GitHub repo
+### Committing changes to GitHub repo
 
 Finally, commit the newly created files to GitHub.
 

docs/recipes/capture-notes-with-shortcuts-and-github-actions.md

@@ -6,7 +6,7 @@ With this #recipe you can create notes on your iOS device, which will automatica
 
 * You use [Foam for VSCode](https://marketplace.visualstudio.com/items?itemName=foam.foam-vscode) to manage your notes
 * You wish to adopt a practice such as [A writing inbox for transient and incomplete notes](https://notes.andymatuschak.org/A%20writing%20inbox%20for%20transient%20and%20incomplete%20notes)
-* You wish to use [Shorcuts](https://support.apple.com/guide/shortcuts/welcome/ios) to capture quick notes into your Foam notes from your iOS device
+* You wish to use [Shortcuts](https://support.apple.com/guide/shortcuts/welcome/ios) to capture quick notes into your Foam notes from your iOS device
 
 ## Other tools
 

docs/recipes/take-notes-from-mobile-phone.md

@@ -53,7 +53,7 @@ If such an app was worth building, it would have to have the following features:
 
 - Instant loading and syncing for quick notes
 - Sleek, simple, beautifully designed user experience.
-- Ability to search and navigate forward links and back links (onlly in paid GitJournal version)
+- Ability to search and navigate forward links and back links (only in paid GitJournal version)
 - Killer feature that makes it the best note taking tool for Foam (?)
 
 Given the effort vs reward ratio, it's a low priority for core team, but if someone wants to work on this, we can provide support! Talk to us on the #mobile-apps channel on [Foam Discord](https://foambubble.github.io/join-discord/w).

docs/recipes/write-your-notes-in-github-gist.md

@@ -44,7 +44,7 @@ When editing a file, you can easily navigate `[[links]]` by hovering over them t
 
 You can view a page's backlinks using either of the following techniques:
 
-1. Expanding the file's node in the `Repositories` tree, since it's child nodes will represent backlinks. This makes it easy to browse your pages and their backlinks in a single hierachical view.
+1. Expanding the file's node in the `Repositories` tree, since it's child nodes will represent backlinks. This makes it easy to browse your pages and their backlinks in a single hierarchical view.
 
 1. Opening a file, and then viewing it's backlinks list at the bottom of the editor view. This makes it easy to read a page and then see its backlinks in a contextually rich way.