foam/docs/recipes.md

Recipes

Guides, tips and strategies for getting the most out of your Foam workspace!

• Contribute
• Take smart notes
• Discover
• Organise
• Write
• Version control
• Publish
• Collaborate
• Workflow
• Creative ideas
• Other

Contribute

• Start by reading [contribution-guide]
• If you discover features not listed here, we'd love to have them! [how-to-write-recipes].

Take smart notes

• Introduction to Zettelkasten [todo]
• Clip webpages with [web-clipper]

Discover

• Explore your notes using [graph-visualisation]
• Discover relationships with [backlinking]
• Simulating [unlinked-references]

Organise

• Using [backlinking] for [reference-lists].

Write

• Link documents with [wiki-links], using Foam's [link-formatting-and-autocompletion].
• Use shortcuts for [creating-new-notes]
• Instantly create and access your [daily-notes]
• Use custom [note-macros] to create weekly, monthly etc. notes
• Draw [diagrams-in-markdown]
• Prettify your links, [automatically-expand-urls-to-well-titled-links]
• Style your environment with [custom-markdown-preview-styles]
• Paste and link [images-from-your-clipboard]
• [shows-image-preview-on-hover]
• Markdown All-in-One features [todo] [good-first-task]
  • Manage checklists
  • Automatic Table of Contents
  • Live preview markdown
  • More...
• VS Code Advanced Features [todo] [good-first-task]
  • Focus with Zen Mode

Version control

• Quick commits with VS Code's built in [git-integration]
• Store your workspace in an auto-synced GitHub repo with [gistpad]
• Sync your GitHub repo automatically [todo].

Publish

• Publish using official Foam template
  • Publish to [github-pages]
  • Publish to [gitlab-pages]
  • Publish to [azure-devops-wiki]
  • Publish to [vercel]
• Publish using community templates
  • [eleventy-and-netlify] by @juanfrank77
  • [foam-gatsby-template] by @mathieudutour
  • foamy-nextjs by @yenly
• Make the site your own by [customising-styles].
• Render math symbols, by either
  • adding client-side [math-support] to the default [github-pages] site
  • adding a custom Jekyll plugin to support [katex-math-rendering]

Collaborate

• Give your team push access to your GitHub repo [todo]
• Real-time collaboration via VS Code Live Share [todo]
• Accept patches via GitHub PRs [todo]

Workflow

• Capture notes from Drafts app on iOS [capture-notes-with-drafts-pro]

Creative ideas

Creative ideas welcome!

• Support Anki cards from notes like Remnote [todo]

See [contribution-guide] and [how-to-write-recipes].

Other

Thought of a recipe but don't see a category for them? Add them here and we'll organise them once we detect a theme.

See [contribution-guide] and [how-to-write-recipes].