Anybody is free to share their recipes on this website or even contribute to the development of saucesource. If you are interested on sharing your recipes or just helping, keep on reading to know how to contribute.
Recipes on this site are stored in Markdown files. Markdown files are nice to read in plain text and are widely known on the internet and in programming circles, so chances are you are already familiar with the format.
However, the markdown files for the recipes in this site contain some additional information at the beginning of the file that is called the "front matter". It looks like this:
+++ title = "Spaghetti alla carbonara" date = 2021-03-07T20:00:00Z [extra] author = "Yaroslav de la Peña Smirnov <yps[at]yaroslavps.com>" website = "https://www.yaroslavps.com/" donate = "https://www.yaroslavps.com/donate/" +++
title— pretty self-explanatory.
date— approximate date and time of publishing in Zulu (UTC+0).
author— Your real name, nickname, pseudonym or just
"Anonymous"if you prefer to remain that way. You can also add your email after your name/nickname if you wish.
website— Your website, or profile link (e.g. Github profile). Optional.
donate— A link where people can tip you some money if they want. Optional.
donate all need to be
under the extra section.
The first picture (if any) and paragraph should be separated from the rest of
the text by a line containing
<!-- more -->. This will allow
the picture and paragraph to appear as a short description in the main list of
The rest of the text is just plain Markdown. For an example take a look here
In order to keep with the site's theme and assure that the site is not bloated with unnecessary information, there are some rules as to what a recipe should contain and how it should be structured:
These rules may change a bit in the future, but not much.
So that the website and your recipe are lighter on bandwidth, it is recommended you optimize your pictures by compressing them. The (JPEG) settings I recommend for a pretty good size/quality ratio are:
If you're using ImageMagick, the command looks something like this:
convert "$input" \ -strip \ -interlace plane \ -define jpeg:dct-method=float \ -sampling-factor 4:2:0 \ -resize 1200x800 \ -quality 80 \ "$output"
If you prefer using a GUI program like GIMP or Photoshop, (most of) these settings should be available when you export your image to JPEG.
There are three ways to publish. The only thing that is required in order to publish is that you have installed a plain text editor that can output text in UTF-8 and an email address from which to send the recipe.
If you are not very tech-savy or don't know just what in the name of god is git, no worries, there is still a way for you to share your recipes on this site. Check the plain text email instructions to learn how.
The main repository for this website is hosted at https://git.sr.ht/~yaroslav/saucesource.cc. The main and recommended way for you to publish your recipes is to send a patch using git send-email to the project's mailing list. This doesn't require to make an account on any service and only requires that you have git installed on your computer properly configured with your email address.
If you are not very familiar with this way of collaborating, I recommend that you read this guide and you'll be ready to collaborate the way git was meant to be used in no time.
If you are more familiar with Github's pull request system, and you can't or don't want to send patches by email, the project has a mirror repository on Github where you can open a pull request to get your recipe added.
The Github mirror is located at https://github.com/Yaroslav-95/saucesource.cc.
If you are not familiar with git you can still send your recipe to me to my personal email address for me to review it and add it to the website. Just make sure that your recipe is properly formatted and send it as an attachment along with any pictures in your recipe to email@example.com.
Important: If you send me an email to my personal address, make sure to add it to your whitelist, or check your spam folder. Especially if you are using something like gmail or outlook.
If you like this website, you can donate some money for the maintenance of the website over here.
You can also donate money to the author of a recipe you liked, if that author provided a donation link in their recipe.
This is just a short kind of to-do list for the short-term:
Everything that is presented in this site is published under the CC-BY-SA 3.0 license. By publishing your recipe in this site, you retain authorship of your recipe (unless you post anonymously), but the recipe is published under the same license as the site.
The "code" or functional part of the site (such as templates, stylesheets and so on) is published under the AGPLv3. By contributing any improvements or modifications to site, they are automatically licensed under the same AGPLv3 license as the site.