Add foam-docs type front matter do documentation notes

This commit is contained in:
Fernando 2023-09-13 10:20:48 +00:00
parent 89af173dc0
commit 17c882c026
57 changed files with 167 additions and 3 deletions

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Backlinking # Backlinking
When using [[wikilinks]], you can find all notes that link to a specific note in the **Connections Explorer** When using [[wikilinks]], you can find all notes that link to a specific note in the **Connections Explorer**

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Foam Commands # Foam Commands
Foam has various commands that you can explore by calling the command palette and typing "Foam". Foam has various commands that you can explore by calling the command palette and typing "Foam".

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Custom Markdown Preview Styles # Custom Markdown Preview Styles
Visual Studio Code allows you to use your own CSS in the Markdown preview tab. Visual Studio Code allows you to use your own CSS in the Markdown preview tab.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Adding Custom Snippets # Adding Custom Snippets
You can add custom snippets whilst the default set of snippets are decided by following the below steps: You can add custom snippets whilst the default set of snippets are decided by following the below steps:

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Daily Notes # Daily Notes
Daily notes allow you to quickly create and access a new notes file for each day. This is a surpisingly effective and increasingly common strategy to organize notes and manage events. Daily notes allow you to quickly create and access a new notes file for each day. This is a surpisingly effective and increasingly common strategy to organize notes and manage events.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Graph Visualization # Graph Visualization
Foam comes with a graph visualization of your notes. Foam comes with a graph visualization of your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Including notes in a note # Including notes in a note
In some situations it might be useful to include the content of another note in your current note. Foam supports this displaying within the vscode environment. Note, this does not work out-of-the-box for your publishing solutions. In some situations it might be useful to include the content of another note in your current note. Foam supports this displaying within the vscode environment. Note, this does not work out-of-the-box for your publishing solutions.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Link Reference Definitions # Link Reference Definitions
When you use `[[wikilinks]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is not needed to navigate your workspace with foam-vscode, but is useful for files to remain compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wikilinks]]`. When you use `[[wikilinks]]`, the [foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) extension can automatically generate [Markdown Link Reference Definitions](https://spec.commonmark.org/0.29/#link-reference-definitions) at the bottom of the file. This is not needed to navigate your workspace with foam-vscode, but is useful for files to remain compatible with various Markdown tools (e.g. parsers, static site generators, VS code plugins etc), which don't support `[[wikilinks]]`.

View file

@ -1,5 +1,5 @@
--- ---
type: feature type: foam-docs
keywords: hello world, bonjour keywords: hello world, bonjour
tags: [hello, bonjour] tags: [hello, bonjour]
--- ---
@ -14,12 +14,12 @@ For example, for this file, we have:
```markdown ```markdown
--- ---
type: feature type: foam-docs
keywords: hello world, bonjour 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 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`). This sets the `type` of this document to `foam-docs` 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. > 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.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Note Templates # Note Templates
Foam supports note templates which let you customize the starting content of your notes instead of always starting from an empty note. Foam supports note templates which let you customize the starting content of your notes instead of always starting from an empty note.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Paste Images from Clipboard # Paste Images from Clipboard
By installing the [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) extension, you can paste an image from the clipboard with `cmd+alt+v`. By installing the [vscode-paste-image](https://github.com/mushanshitiancai/vscode-paste-image) extension, you can paste an image from the clipboard with `cmd+alt+v`.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Resource Filters # Resource Filters
Resource filters can be passed to some Foam commands to limit their scope. Resource filters can be passed to some Foam commands to limit their scope.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Spell Checking # Spell Checking
There are many spell checking extensions for VS Code. There are many spell checking extensions for VS Code.

View file

@ -1,4 +1,5 @@
--- ---
type: foam-docs
tags: my-tag1 my-tag2 my-tag3/notes tags: my-tag1 my-tag2 my-tag3/notes
--- ---

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Wikilinks # Wikilinks
Wikilinks are the internal links that connect the files in your knowledge base. (Also called `[[MediaWiki]]` links). Wikilinks are the internal links that connect the files in your knowledge base. (Also called `[[MediaWiki]]` links).

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Frequently Asked Questions # Frequently Asked Questions
> ⚠️ Foam is still in preview. Expect the experience to be a little rough. > ⚠️ Foam is still in preview. Expect the experience to be a little rough.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Creating New Notes # Creating New Notes
- Write out a new `[[wikilink]]` and `Cmd` + `Click` to create a new file and enter it. - Write out a new `[[wikilink]]` and `Cmd` + `Click` to create a new file and enter it.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Getting started with VS Code # Getting started with VS Code
VS Code is a powerful text editor, hidden behind a simple interface. VS Code is a powerful text editor, hidden behind a simple interface.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Keyboard Shortcuts # Keyboard Shortcuts
Here are some keyboard shortcuts you'll love when editing your notes. Here are some keyboard shortcuts you'll love when editing your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Recommended Extensions # Recommended Extensions
These extensions defined in `.vscode/extensions.json` are automatically installed when you accept the workspace's recommended extensions. These extensions defined in `.vscode/extensions.json` are automatically installed when you accept the workspace's recommended extensions.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Sync notes with source control # Sync notes with source control
Source control is a way to precicely manage the history and content of a directory of files. Source control is a way to precicely manage the history and content of a directory of files.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Writing Notes # Writing Notes
Notes are simple text files with some extra flavor, in the shape of Markdown syntax and support for extra properties (see [[note-properties]]). Notes are simple text files with some extra flavor, in the shape of Markdown syntax and support for extra properties (see [[note-properties]]).

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Using Foam # Using Foam
Foam is a collection VS Code extensions and recipes that power up the editor Foam is a collection VS Code extensions and recipes that power up the editor

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Generate a site using Gatsby # Generate a site using Gatsby
## Using foam-gatsby-template ## Using foam-gatsby-template

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Katex Math Rendering # Katex Math Rendering
Apart from using the method mentioned in [[math-support-with-mathjax]], we can also use KaTeX to render our math equations in Foam. The caveat is: we can't rely on GitHub Pages to host and deploy our website anymore, because the plugin we'll be using to let Jekyll support KaTeX doesn't play well together with GitHub Pages. Apart from using the method mentioned in [[math-support-with-mathjax]], we can also use KaTeX to render our math equations in Foam. The caveat is: we can't rely on GitHub Pages to host and deploy our website anymore, because the plugin we'll be using to let Jekyll support KaTeX doesn't play well together with GitHub Pages.

View file

@ -1,4 +1,5 @@
--- ---
type: foam-docs
layout: mathjax layout: mathjax
--- ---

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Publish to Azure DevOps Wiki # Publish to Azure DevOps Wiki
Publish your Foam workspace as an Azure DevOps wiki. Publish your Foam workspace as an Azure DevOps wiki.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# GitHub Pages # GitHub Pages
1. In VSCode workspace settings set `"foam.edit.linkReferenceDefinitions": "withoutExtensions"` 1. In VSCode workspace settings set `"foam.edit.linkReferenceDefinitions": "withoutExtensions"`

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Publish to GitHub # Publish to GitHub
The standard [foam-template](https://github.com/foambubble/foam-template) is ready to be published to GitHub, and GitHub pages. The standard [foam-template](https://github.com/foambubble/foam-template) is ready to be published to GitHub, and GitHub pages.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# GitLab Pages # GitLab Pages
You don't have to use GitHub to serve Foam pages. You can also use GitLab. You don't have to use GitHub to serve Foam pages. You can also use GitLab.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Publish to Netlify with Eleventy # Publish to Netlify with Eleventy
You can use [foam-eleventy-template](https://github.com/juanfrank77/foam-eleventy-template) to generate a static site with [Eleventy](https://www.11ty.dev/), and host it online on [Netlify](https://www.netlify.com/). You can use [foam-eleventy-template](https://github.com/juanfrank77/foam-eleventy-template) to generate a static site with [Eleventy](https://www.11ty.dev/), and host it online on [Netlify](https://www.netlify.com/).

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Publish to Vercel # Publish to Vercel
This #recipe shows you how to deploy the default Foam website template to Vercel. This #recipe shows you how to deploy the default Foam website template to Vercel.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Publishing pages # Publishing pages
Foam pages can be published. Foam pages can be published.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Add images to your notes # Add images to your notes
This #recipe allows you to paste images on to your notes. This #recipe allows you to paste images on to your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Automatically Sync with Git # Automatically Sync with Git
With this #recipe you can regularly commit and push to git, to keep your repo in always synched. With this #recipe you can regularly commit and push to git, to keep your repo in always synched.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Automatically Expand URLs to Well-Titled Links # Automatically Expand URLs to Well-Titled Links
With this #recipe you can convert a link to a fully-formed Markdown link, using the page's title as a display name. Useful for citations and creating link collections. With this #recipe you can convert a link to a fully-formed Markdown link, using the page's title as a display name. Useful for citations and creating link collections.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Capture Notes With Drafts Pro # Capture Notes With Drafts Pro
With this #recipe you can create notes on your iOS device, which will automatically be imported into Foam. With this #recipe you can create notes on your iOS device, which will automatically be imported into Foam.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Capture Notes With Shortcuts and GitHub Actions # Capture Notes With Shortcuts and GitHub Actions
With this #recipe you can create notes on your iOS device, which will automatically be imported into Foam. With this #recipe you can create notes on your iOS device, which will automatically be imported into Foam.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Diagrams in Markdown # Diagrams in Markdown
We have two alternative #recipe for displaying diagrams in markdown: We have two alternative #recipe for displaying diagrams in markdown:

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# How to Write Recipes # How to Write Recipes
This is an example of how to structure a Recipe. The first paragraph or two should explain the purpose of the recipe succinctly, including why it's useful, if that's not obvious. This is an example of how to structure a Recipe. The first paragraph or two should explain the purpose of the recipe succinctly, including why it's useful, if that's not obvious.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Make Backlinks More Prominent # Make Backlinks More Prominent
One of the most most common early feature requests in Foam is to make the Markdown Notes Backlinks Explorer more prominent. One of the most most common early feature requests in Foam is to make the Markdown Notes Backlinks Explorer more prominent.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Markup Converter # Markup Converter
This #recipe allows you to convert any document into Markdown for storing them in your notes. This #recipe allows you to convert any document into Markdown for storing them in your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Migrating from Obsidian (stub) # Migrating from Obsidian (stub)
**[[todo]] This [[roadmap]] item needs more specification work.** **[[todo]] This [[roadmap]] item needs more specification work.**

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Migrating from OneNote # Migrating from OneNote
This guide mostly duplicates the instructions at the repo for the PowerShell [script](https://github.com/nixsee/ConvertOneNote2MarkDown). This guide mostly duplicates the instructions at the repo for the PowerShell [script](https://github.com/nixsee/ConvertOneNote2MarkDown).

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Migrating from Roam (stub) # Migrating from Roam (stub)
**[[todo]] This [[roadmap]] item needs more specification work.** **[[todo]] This [[roadmap]] item needs more specification work.**

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Custom Note Macros # Custom Note Macros
This #recipe allows you to create custom note macros. This #recipe allows you to create custom note macros.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Pre-defined User Snippets # Pre-defined User Snippets
This #recipe allows us to introduce Roam style commands to Foam, by using [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets). Consider the below snippets: This #recipe allows us to introduce Roam style commands to Foam, by using [VS Code Snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets). Consider the below snippets:

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Real-time Collaboration # Real-time Collaboration
This #recipe is here to just tell you that VS Code Live Share will allow you to collaborate live on your notes. This #recipe is here to just tell you that VS Code Live Share will allow you to collaborate live on your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Search for Notes # Search for Notes
This #recipe contains tips on how to leverage VS Code search features. This #recipe contains tips on how to leverage VS Code search features.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Shows Image Preview on Hover # Shows Image Preview on Hover
This #recipe allows you to see a preview of an image on hover. This #recipe allows you to see a preview of an image on hover.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Take notes on mobile phones # Take notes on mobile phones
This #recipe offers solutions to taking Foam notes on the go. This #recipe offers solutions to taking Foam notes on the go.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Web Clipper # Web Clipper
This #recipe allows you to convert any web content into Markdown for storing them in your notes. This #recipe allows you to convert any web content into Markdown for storing them in your notes.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Write your notes in GitHub Gist # Write your notes in GitHub Gist
This #recipe will allow you to persist your notes in a GitHub repository, and automatically sync changes without needing to manually commit/push/pull, then GistPad might be an option worth exploring. This #recipe will allow you to persist your notes in a GitHub repository, and automatically sync changes without needing to manually commit/push/pull, then GistPad might be an option worth exploring.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Command Line Interface # Command Line Interface
Create a CLI tool to allow running common Foam commands. These may include: Create a CLI tool to allow running common Foam commands. These may include:

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Foam logging in VsCode # Foam logging in VsCode
The Foam extension logs details about what its doing in vscode's `Output` tab. The Foam extension logs details about what its doing in vscode's `Output` tab.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Orphaned Notes # Orphaned Notes
Foam helps you to find orphans: notes that have neither forward links nor backlinks. Foam helps you to find orphans: notes that have neither forward links nor backlinks.

View file

@ -1,3 +1,6 @@
---
type: foam-docs
---
# Janitor # Janitor
To store your personal knowledge graph in markdown files instead of a database, we need some additional tooling to create and maintain relationships with notes. To store your personal knowledge graph in markdown files instead of a database, we need some additional tooling to create and maintain relationships with notes.