You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

47 lines
1.7 KiB

6 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
  1. # Chowdown
  2. A simple, plaintext recipe database for hackers
  3. [http://chowdown.io](http://chowdown.io)
  4. # Getting Started
  5. This is a Jekyll build. Make sure you have Jekyll [installed](https://jekyllrb.com/). To install, run this command in the terminal (or iTerm, etc):
  6. ```gem install bundler jekyll```
  7. or to check if you've got it installed already:
  8. ```jekyll -v```
  9. Clone or download this repo. Navigate to the folder in terminal (or iTerm, etc), and then run:
  10. ```jekyll serve```
  11. With default settings, you should be able to view the site locally at `http://127.0.0.1:4000/`
  12. # Writing a Recipe
  13. The recipes are stored in the collection "Recipes" (the folder /_recipes).
  14. They are written in Markdown and contain a few special sections:
  15. - The frontmatter, which contains:
  16. - Title, Image, and Layout (which is "recipe")
  17. - Ingredients (a list of things in the dish)
  18. - Directions (a list of steps for the dish)
  19. - Body content (for intros, stories, written detail)
  20. If you need help with Markdown, here's a [handy cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
  21. # Writing a component recipe
  22. A component recipe is a special recipe made up of other recipes. To make a new component recipe:
  23. - place your smaller, single recipes into the /_components folder
  24. - make a new recipe like normal in the /_recipes folders
  25. - in the frontmatter of this new recipe, include your recipes from the /_components folder (instead of the usual Ingredeints list)
  26. You can an example on the Red Berry Tart recipe.
  27. - [example Markdown](https://raw.githubusercontent.com/clarklab/chowdown/gh-pages/_recipes/red-berry-tart.md)
  28. - [example recipe page](http://chowdown.io/recipes/red-berry-tart.html)