README file from
GithubRecipe Box
Plan meals, build grocery lists, and view recipes as interactive cards, all stored as plain markdown in your vault.
Recipe Box treats recipes the same way Obsidian treats everything else: as notes you own. Meal plans and grocery lists are markdown files too, so you can edit them by hand, query them with Dataview or Bases, and sync them with whatever sync solution you already use.
🎉 NEW! Import your recipe collection from Mealie and other apps
Feature Highlights
🍽️ Recipe view
Open any recipe note and Recipe Box renders it as an interactive card with a scalable ingredient list, step-by-step instructions with inline timers, and nutrition at a glance. The header is fully configurable, allowing you to surface any frontmatter property as a badge, write custom formula expressions, or stick with the defaults. Scale a recipe up or down and every ingredient amount updates automatically.
[!TIP] Multiple recipe view layouts are available: Choose between a single column or two column split for desktop; and a dedicated mobile view.
📅 Meal planning
Drag recipes onto a weekly planner, drop files straight from the file explorer, or add custom meals without a recipe note attached. A queue holds anything unscheduled. The plan lives in a plain markdown note you can read and edit directly, there's no hidden database.
🎲 Meal suggestions
The suggester does more than shuffle your recipe list. You can use it to build named modes with custom filters (cuisine, prep time, allergens, or any frontmatter field) and scoring rules (favor highest rated, least recently cooked, never made, or any combination). Run a mode for dinner, run another for lunch. Select results and schedule them across the week in one step.
🛒 Grocery list
Ingredients from your meal plan are consolidated automatically... quantities summed, duplicates merged... and then grouped by category, recipe, or source. Add ad-hoc items easily, check things off as you shop, and export in multiple formats. The list is a markdown note, editable by hand or through the plugin.
✏️ Recipe editing
Fix a recipe without leaving the card. Click the Ingredients or Instructions heading, or use the Edit recipe button, to open a structured editor: change or remove entries, drag to reorder (or Alt+Up/Down), move items between groups, and add, rename, or delete groups. Times, servings, image, notes, and nutrition are editable too, and the note can be renamed from the same dialog. Only what you change is written, so the rest of your note is left untouched. Sections with content the editor can't safely represent (paragraphs, nested lists, multi-line steps) offer an Open as Markdown shortcut instead.
📓 Cook history
Mark a recipe as cooked and Recipe Box logs the date, optional notes, and a photo. History is stored as a structured array in frontmatter, making it queryable with Dataview or Obsidian Bases. Find every recipe you cooked last month, your most-made meals, or anything you haven't made in over a month -- all from a standard Dataview query.
📥 Recipe import
Paste a URL from most recipe sites and Recipe Box extracts ingredients, instructions, and metadata into a new note using the built in recipe template, or you can set your own template to use. Plain text and pasted captions work too, for recipes that don't come from a structured page.
Moving from another recipe app? Import your whole collection at once from Mealie, or from any app that exports schema.org Recipe JSON. Pick the exported .json or .zip files, choose a folder, and Recipe Box turns each recipe into a note, images included. Existing notes are never overwritten.
🔗 Recipe sharing
Share any recipe with a link, no account or app required on the other end. Recipe Box generates a clean, read-only page with the ingredients, instructions, and photo, styled to feel like Obsidian rather than a generic web page, with automatic dark mode. Set an expiry of 7, 30, or 90 days, and revoke a share instantly if you change your mind. Nothing beyond the recipe itself leaves your vault, no cook history, no other notes, no vault structure.
📱 Mobile
A tab-based layout with swipe navigation keeps the recipe view clean on small screens. Cook History gets its own tab. Long-press to drag recipes on the meal plan. A cook mode toggle keeps your screen awake while you're at the stove.
⏱️ Timers
Duration phrases in your instructions ("bake for 30 minutes") become tappable timer buttons. Run several at once, drag them anywhere on screen, and get an audio alert when they finish.
Installation
Obsidian Community Direcotry
Recipe Box is available in the Obsidian community plugin directory and can be installed through the in-app browser.
You can also view the plugin directory listing by visiting https://community.obsidian.md/plugins/recipe-box
BRAT (for beta releases)
- Install the BRAT plugin from the Obsidian community plugins directory and enable it.
- Open BRAT settings and click Add Beta Plugin.
- Enter
AdamArcane/obsidian-recipeboxand click Add Plugin. - Enable Recipe Box in Settings → Community plugins.
BRAT will notify you when new beta releases are available and can update the plugin automatically.
Manual
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Create the folder
<your vault>/.obsidian/plugins/recipe-box/if it does not exist. - Copy the three files into that folder.
- Reload Obsidian and enable Recipe Box in Settings → Community plugins.
Getting started
Drop a note into the Recipes folder (created automatically the first time you enable the plugin), structure ingredients and instructions under headings of your choice, or using RecipeMD format, and open it. Recipe Box detects any note in that folder as a recipe and offers to switch into recipe view, no frontmatter required.
Want recipes somewhere else, or mixed in with other notes? Change the recipe folder, or set a recipe type value (recipe, for example, matched against a frontmatter property) to narrow detection further, under Settings → Recipe Box → Recipe library.
[!NOTE] Notes written in RecipeMD format, ingredients and instructions separated by thematic breaks (
---) instead of headings, work the same way with no extra setup. An explicit heading always takes precedence when both are present.
License
GPL-3.0-or-later