Skip to content
Jekyll cms site for restcookbook.com
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_plugins
_posts
config
css
fonts
img
js
.gitignore
404.html
Capfile
README.md
_config.yml
android-icon-144x144.png
android-icon-192x192.png
android-icon-36x36.png
android-icon-48x48.png
android-icon-72x72.png
android-icon-96x96.png
apple-icon-114x114.png
apple-icon-120x120.png
apple-icon-144x144.png
apple-icon-152x152.png
apple-icon-180x180.png
apple-icon-57x57.png
apple-icon-60x60.png
apple-icon-72x72.png
apple-icon-76x76.png
apple-icon-precomposed.png
apple-icon.png
browserconfig.xml
favicon-16x16.png
favicon-32x32.png
favicon-96x96.png
favicon.ico
feed.xml
index.html
manifest.json
ms-icon-144x144.png
ms-icon-150x150.png
ms-icon-310x310.png
ms-icon-70x70.png
sitemap.txt
sitemap.xml

README.md

Contributing to the REST cookbook

The REST cookbook website uses Jekyll, a simple yet powerful blog engine that easily allows for creating simple websites like these.

Contributing to our site is simple:

  • Fork the website to your own github account.
  • Clone your repository onto your computer. Make sure you create a new branch, and not use the master branch.
  • Create a new page inside the /_posts/* directory. This HAS GOT TO BE IN THE FORMAT OF YEAR-MONTH-DAY-FILENAME.html!!!
  • Add and commit your changes, and push it to your repository.
  • Create a pull request and we will try and merge your recipe.

Creating a new page

As said, a page must be placed in the _post directory, and in the year-month-day-filename.html format. Otherwise it wont get picked up by the system. Every post should look somewhat like this:

---
layout: recipe
title: <Title>
category: <Category>
author: <your name>
author_email: <your email address>
---
<h2>Title</h2>

<p>Your recipe</p>

The author_email address is optional. Make sure the category name is one of the existing category names (case matters), otherwise your posting will be added inside a new topic. If you have troubles creating a new page, take a look at one of the existing pages, or ask us for help.

Regenerating a new site

There are two ways to display your new site:

Run as a standalone webserver:

  • Start jekyll in your repository root with: jekyll server
  • Browse to http://:4000 to see your site

Run inside an existing webserver:

  • Make sure your use the _site directory as your document root

When you make changes, you need to regenerate your website. This can be done by running jekyll without any parameters. This regenerates the _site directory.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.