Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chowdown cmd utility #42

Open
wants to merge 13 commits into
base: gh-pages
Choose a base branch
from
Open

Chowdown cmd utility #42

wants to merge 13 commits into from

Conversation

rathgar
Copy link
Contributor

@rathgar rathgar commented May 6, 2020

If you create a lot of recipes, you might find yourself not remembering all of the options available in the front matter. I do a lot and I keep having to look them up so I created this tool to help. I've polished it up a little so it's more useful to other folk too.

Right now it can create recipe files for you and populate them with the known options so you have a reference to hand when you're writing them.

Basic usage:

> bin/chowdown new recipe "Grandma's Famous Cookies"
·C·H·O·W·D·O·W·N·
Created: _recipes/grandmas-famous-cookies.md
  Use the same naming structure for any images.
  eg: 'images/grandmas-famous-cookies.jpg'

If you made a mistake you can also call:

bin/chowdown delete recipe "Grandma's Famous Cookies"
·C·H·O·W·D·O·W·N·
Deleting: _recipes/grandmas-famous-cookies.md

Deletion is the only time it will touch an existing file. It won't clobber existing files so if you call it with new on an existing recipe it will exit with a message.

The created file's contents come from a template file which should be kept up to date as more options, such as books, chefs, timings, etc. are added. This then acts as a form of documentation for the user, right where they need it.

I've yet to add components but it's been written to handle any number of types. It was written in ruby as jekyll is ruby so it's likely to be on the local system.

Sorry @clarklab, more of my rubbish for you 😜

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant