Giter Club home page Giter Club logo

chowdown's Introduction

Chowdown

A simple, plaintext recipe database for hackers

http://chowdown.io

Getting Started

This is a Jekyll build. Make sure you have Jekyll installed. To install, run this command in the terminal (or iTerm, etc):

gem install bundler jekyll

or to check if you've got it installed already:

jekyll -v

Clone or download this repo. Navigate to the folder in terminal (or iTerm, etc), and then run:

jekyll serve

With default settings, you should be able to view the site locally at http://127.0.0.1:4000/

Writing a Recipe

The recipes are stored in the collection "Recipes" (the folder /_recipes).

They are written in Markdown and contain a few special sections:

  • The frontmatter, which contains:
  • Title, Image, and Layout (which is "recipe")
  • Ingredients (a list of things in the dish)
  • Directions (a list of steps for the dish)
  • Body content (for intros, stories, written detail)

If you need help with Markdown, here's a handy cheatsheet.

Writing a component recipe

A component recipe is a special recipe made up of other recipes. To make a new component recipe:

  • place your smaller, single recipes into the /_components folder
  • make a new recipe like normal in the /_recipes folders
  • in the frontmatter of this new recipe, include your recipes from the /_components folder (instead of the usual Ingredeints list)

You can an example on the Red Berry Tart recipe.

chowdown's People

Contributors

clarklab avatar di-dc avatar kn4ck3r avatar maartenpaauw avatar michaelthomasmpt avatar mrstegeman avatar pgardella-globant avatar rathgar avatar skn0tt avatar trungduyvu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

chowdown's Issues

Change blue to "food" color?

Would you be open to changing the blue color to one more suitable for food? Maybe #CC0000? Red, I've found, is commonly found in fast food and restaurants.

While blue is one of the most popular colors it is one of the least appetizing. Blue food is rare in nature. Food researchers say that when humans searched for food, they learned to avoid toxic or spoiled objects, which were often blue, black, or purple. When food dyed blue is served to study subjects, they lose appetite.

Green, brown, and red are the most popular food colors. Red is often used in restaurant decorating schemes because it is an appetite stimulant.

http://www.infoplease.com/spot/colors1.html

fullscreen_6_27_15__8_38_pm

Docker

Hi. I'm wondering if it's on your roadmap to make this available via docker.

Service command path?

Hey there, apologies in advance for the total noob question (I'm super new to this and still learning).

What's the command path I need to put for the service .ini?

command=%(ENV_HOME)s/chowdown/[file path here]

Thank you all so much in advance!

Provide layouts to plugin to existing Jekyll websites.

Hello!

I love the idea and use case for chowdown. I currently have an existing Jekyll website, and would love to be able to use markup for my recipes. This seems like the most maintained place to find such a thing.

I've taken

_data/nutrients.yml
_includes/nutritional-information.html
_layouts/recipe.html

Into my existing website though I'm failing to have proper formatting.

image

Is there any interest in the maintainers providing the files and docs necessary to add recipe markup in an existing jekyll blog?

feature-request: ingredient sub-sections / sub-lists

The app currently doesn't have a way to divide the ingredient list up which can be helpful in case of cakes for example in which you prepare the topping seperately. This could be achieved by nesting lists natively in yaml.
Currently nested lists are not accepted as valid yaml.

Example:

- Test
-   - 4 eggs
    - 1/4 cup heavy cream
    - 2 tsp vanilla 
    - sprinkle of sugar
    - 4 cups Nilla Wafers Minis

(according to this stackoverflow post)
shows as

  • Test
  • [“4 eggs”, “1/4 cup heavy cream”, “2 tsp vanilla”, “sprinkle of sugar”, “4 cups Nilla Wafers Minis”]

instead of

  • Test
    • 4 eggs
    • 1/4 cup heavy cream
    • 2 tsp vanilla
    • sprinkle of sugar
    • 4 cups Nilla Wafers Minis

Clarify Getting Started section of readme

The last line of the Getting Started section of the readme states:

With default settings, you should be able to view the site locally at http://127.0.0.1:4000/

I chose to install Chowdown within LXC on an Ubuntu server with no desktop. I had no issues with the Jekyll and Chowdown installations, but couldn't access the actual site from my LAN. I spent a few hours validating firewall settings, IP addessing on the container, reading the individual Chowdown files, and digging through Jekyll documentation before I happened upon an obscure post on Stackoverflow.

I think it would be good to add that Jekyll can be launched with the --host=0.0.0.0 option (or a specific IP can be specified if you don't want to bind to all ports). Or possibly replace the 'serve locally' configuration altogether. I'd imagine more people are interested in accessing their Chowdown site from their LAN or the internet than specifically on whatever machine they installed it on.

So for the actual proposals.

Option 1:
Add a new sentence right after

With default settings, you should be able to view the site locally at http://127.0.0.1:4000/

"To access Chowdown remotely, use the command jekyll serve --host=0.0.0.0 to bind Jekyll to all interfaces on the server. Ensure firewall rules are in place to allow remote access. You should then be able to view the site by browsing to http://[Server IP]:4000."

Option 2:
Starting with the line

Clone or download this repo. Navigate to the folder in terminal (or iTerm, etc), and then run:

  • Replace jekyll serve with jekyll serve --host 0.0.0.0
  • Replace "With default settings, you should be able to view the site locally at http://127.0.0.1:4000/" with "You should be able to access Chowdown remotely using the server IP by browsing to http://[Server IP]:4000/"

Beta: Search breaks layout

In the new beta design entering anything into the search box breaks the complete layout.

The reason is, that the height of the slider and the search box diff are both reduced by the following code:

	$('#search-input').on('input', function() {
	  currentHeight = $('#search-container').outerHeight();
	  $('.search').addClass('used').css('height', currentHeight);
	});

I am not sure what the intention is, but removing the code makes things nicely usable.

PS: Just starting to look into chwodown, but it seems to be something I was missing for a long time 👍

Group recipes in books

Hey @clarklab - I remember reading a whole ago that you were planning on creating the concept of "books" to group recipes together and display them as a collection of sorts. I was just wondering whether you'd started any work on that so far? I'd be interested in helping contribute to it if there was a branch to work from, or if you had a guiding vision of sorts I could code towards. :)

Links on main page are not clickable

Might not be relevant with the code from the beta release, mentioning it nevertheless:

All links below For the home chef and For the developer are not clickable (neither is the text selectable) with a desktop browser.

In the small mobile view everything is fine. Things are also working when tweaking the CSS to use the mobile special case.

Problematic snippet:

.bg-blue-tile{background: #007FFF url(../assets/tile.png); position:relative;}
@media all and (min-width:40em){
.bg-blue-tile:after{position:absolute; top:0; left:0; right:0; bottom:0; content:" "; box-shadow:inset 0 0 100px 20px #007FFF; z-index:1;}
}

Tags

Hello,

I have created several recipes with tags.
I thought it was possible to search with tags but apparently it is not the case.

Can you tell me what the tags are used for and how I can use them to search with?

Thank you in advance,

A new chowndown user already convinced :)

PS: Thanks for all the work done on the framework :) It looks great!

Search displays only the first 10 results

Sorry if i'm wrong but I made several tries, on my own chowdown instance and on chowdown.io and chowdown beta, when I search by ingredient, tag or title, only the first ten results are displayed...
How can I display the whole result ?

Thanks ;)

Search showing no results

Is there anything else needed to get search functionality to work beyond what's in the repo and config defaults? After getting my recipes in, building, and then serving via localhost...the search field returns nothing (including on the beta page).

Install

Hi,
I'm new to this and this sounds really great. How do i get this working?

Many Thanks
Cole

Base64 embedded image?

Howdy,

Can an image be base64 embedded vs referred to locally? I want to make sure that every recipe is stand-alone to prevent data loss.

Add Recipe button/form

it would be pretty awesome to be able to add a recipe without editing a config file. like maybe a recipe editor.

Superseded attributes for Recipe

Hi Clark ,

thanks for your awesome work, really appreciate that you opensourced it! I think I found some minor flaws in the itemdrop properties you are using.
Having a look a http://schema.org/Recipe it seems as if those are superseded by more specific attributes.

used by spec
ingredient recipeIngredient
instructions recipeInstructions

Cheers

Let's talk front-end!

Hello chefs!

We've got a sharpened design in the works (based on the current beta) and I'm planning on doing a full rewrite of the front-end. The goal is cleaner markup and a lighter pageweight. Doing this for a few reasons:

  • I've tried running Chowdown on an Echo Show device and it really chugged
  • I want the Chowdown theme to be easy to edit and style, even for beginners (which includes me, often)
  • on that note, I'm thinking about going framework-free

For my day job, I run a little design/dev shop with my wife. One of our least favorite things is inheriting a complex build with a lot of build process and poor documentation. I'm not ashamed to admit that I'm not really a fan of the command line. I know, I know, but I find simple builds easiest to share down the line (adding new devs of all skill sets over time).

Currently the site uses Basscss (my favorite, which I know most folks have never heard of). I'd compare it to Tailwind. Which looks great! And also a little scary. And maybe a bit heavy. I know with tooling it's a really efficient little kit, but like I said above, I'd love to avoid tooling if possible.

So, my question: are y'all cool with that?

In the absence of a framework, are there some simple things y'all want to suggest? A naming convention? A certain layout type (floats, flexbox, grid)?

Website not displaying correctly.

Hi Clark!

For some reason the website is not displaying correctly when I push it into my own repo.

Current Website: My Online Recipes

Steps:

  1. I created my own repo on Github called "recipes"
  2. I cloned your repo locally.
  3. I deleted your CNAME file.
  4. I then changed the remote url from your repo url to my "recipes" url.
  5. I added, committed, and push the files to my repo.

Oddly enough, when I run jekyll serve locally, the website looks normal. –Any thoughts?

Update Getting Started

Great project. When I tried to follow the getting started instructions I ran into some errors when running jekyll serve.

Haven't used jekyll before but eventually worked once i changed
baseurl: "https://chowdown.io" to baseurl: ""

Just posting this here in case anyone else runs into a similar issue. Maybe there is an option that ignores then when running locally that can be added to quick start?

Pre-install question

Hi,
Looking for a way to implement my markdown recipe collection and was pointed to chowdown.
I have a question: How would the front matter be used to reflect an ingredient list such as below. I don't think it fair to consider it a component recipe.

`## Ingredients
For the chocolate meringue

  • 6 large egg whites
  • 300 grams caster sugar
  • 3 tablespoons cocoa powder (sieved)
  • 1 teaspoon balsamic vinegar (or red wine vinegar)
  • 50 grams dark chocolate (finely chopped)

For the topping

  • 500 millilitres double cream
  • 500 grams raspberries
  • 3 tablespoons dark chocolate (coarsely grated)`

Chowdown as a gem-based theme ?

Hello,

I really like your theme and I would like to use it for my website. There are some small tweaks I want to make and I was looking for the best way to apply them without loosing the ability to update the theme when there is a change here.

I’m new to Jekyll, but I found there is an official way : the gem-based themes. I think it would be the perfect solution for me (and maybe others), since I could override some files without having to edit the master theme.

The transition from a traditional theme to a gem-based one seems not too complicated, if I understand the documentation correctly. But you do need to create an account on https://rubygems.org/ in order to upload the gem. I guess it should be the creator of the theme, so @clarklab, to do it ?

Anyway, thanks for the work you did so far ! And let me know if I can help, though I have only really limited knowledge of Jekyll and Ruby…

recipe format

is there a comprehensive list of the recipe format?

or better question; is the recipe format pretty much done? (if the latter, I wrote an exporter for nextcloud cookbook's format to cooperate with chowdown: https://github.com/AdamRGrey/ncrecipe-to-chowdown/, but it just dumps a url source and author line into the description)

Search doesn't search components, or ingredients in component recipes

The search field does not seem to search for component recipes, or ingredients within recipes composed of components.

For example, in the demo instance, if I search "graham" the component for "Graham Cracker Crust" does not surface in results.

If I search "eggs" neither the Vanilla Custard Filling component, nor the Red Berry Tart recipe surface.

I think it would be useful to be able to search for components (maybe I want to use my Graham Cracker Crust for some other type of tart) and to have ingredients within component recipes be searchable. Might this be possible?

License

I am thinking about creating a fork of chowdown that is based on Gatsby.
If that's OK with you, I'd be happy if you could add an open-source license to chowdown so that is legally alright.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.