Documentation

Exporters

Obsidian

Cooksync supports exporting data to Obsidian. Due to Obsidian’s architecture, Cooksync will export data whenever the Obsidian app is opened on your phone or desktop. Powerful custom templating is supported in the export.

Setup

  • Open the Obsidian app.
  • Go to Settings, then navigate to Community Plugins → Browse and search for Cooksync.
  • Install Cooksync, then open the Cooksync settings page to authenticate, adjust settings, and start syncing. On the settings page you can configure how you want the output to be formatted.
  • Once setup is complete, recipes will sync automatically when you open Obsidian. You can also manually trigger a sync by opening the command palette and typing “cooksync”.

Configure export format

You can configure the export to your preferred format. For this we leverage the Handlebars templating language. Read more about formatting in the Handlebars docs or see below. For further formatting inspiration, check out the recipemd specification.

Available fields

  • title
  • description
  • ingredients
  • instructions
  • imageUrl
  • inputUrl - the url of the recipe
  • createdAt
  • source - the word website or social media
  • recipeYield
  • totalTime - ISO 8601 duration
  • calories
  • keywords - comma separated list of keywords
  • recipeCuisine
  • recipeCategory
  • sourceType - the word website, instagram, tiktok or youtube
  • tags - space separated list of tags

Helper functions

time

The "time" helper function accepts two arguments: the field to format and an optional format string. It will try its best to format both dates and ISO 8601 format(used for recipe duration fields).

{{time createdAt format="MM/dd/yyyy"}}
{{time createdAt}}
Defaults to a localized, human-readable date representation.
{{time totalTime}}
TotalTime is in ISO 8601 format(e.g., PT30M for 30 minutes). Use the time function to transform the duration into a more readable format.

raw

Outputs the raw json output containing all fields.

{{raw}}

uppercase

Converts the string to uppercase.

{{uppercase title}}

Example template

---
tags: {{tags}} cooksync/{{sourceType}}
---
![{{title}}]({{imageUrl}})

{{description}}

Source: {{sourceType}}
Yield: {{recipeYield}}
Calories: {{calories}}
Total time: {{time totalTime}}
Created at: {{time createdAt}}
Keywords: {{keywords}}
Recipe cuisine: {{recipeCuisine}}
Recipe category: {{recipeCategory}}

Source: {{inputUrl}}

---

{{#each ingredients}}
- {{{this}}}
{{/each}}

---

{{#each instructions}}
{{{this}}}

{{/each}}