Browse Source

readme

master
Clark Wimberly 3 years ago
parent
commit
cd15980288
3 changed files with 60 additions and 4 deletions
  1. +2
    -2
      _site/feed.xml
  2. +29
    -1
      _site/readme.md
  3. +29
    -1
      readme.md

+ 2
- 2
_site/feed.xml View File

@ -5,8 +5,8 @@
<description>The plain text recipe database for hackers</description>
<link>http://localhost:4000/</link>
<atom:link href="http://localhost:4000/feed.xml" rel="self" type="application/rss+xml"/>
<pubDate>Wed, 22 Aug 2018 20:43:34 -0500</pubDate>
<lastBuildDate>Wed, 22 Aug 2018 20:43:34 -0500</lastBuildDate>
<pubDate>Wed, 22 Aug 2018 20:51:12 -0500</pubDate>
<lastBuildDate>Wed, 22 Aug 2018 20:51:12 -0500</lastBuildDate>
<generator>Jekyll v3.8.3</generator>
<item>


+ 29
- 1
_site/readme.md View File

@ -2,4 +2,32 @@
A simple, plaintext recipe database for hackers
[http://clarklab.github.io/chowdown](http://clarklab.github.io/chowdown)
[http://clarklab.github.io/chowdown](http://clarklab.github.io/chowdown)
# Getting Started
This is a Jekyll build. Make sure you have Jekyll [installed](https://jekyllrb.com/). To install:
```gem install bundler jekyll```
or to check if you've got it installed already:
```jekyll -v```
Clone or download this repo. Once inside, 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)

+ 29
- 1
readme.md View File

@ -2,4 +2,32 @@
A simple, plaintext recipe database for hackers
[http://clarklab.github.io/chowdown](http://clarklab.github.io/chowdown)
[http://clarklab.github.io/chowdown](http://clarklab.github.io/chowdown)
# Getting Started
This is a Jekyll build. Make sure you have Jekyll [installed](https://jekyllrb.com/). To install:
```gem install bundler jekyll```
or to check if you've got it installed already:
```jekyll -v```
Clone or download this repo. Once inside, 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)

Loading…
Cancel
Save