From 9e997452760399c4cc8cee7a1d39952f8112995c Mon Sep 17 00:00:00 2001 From: Sylvain Gauthier Date: Fri, 12 Mar 2021 08:46:07 +1100 Subject: use a clean Makefile system to build/deploy site This way, we get dependency/smart update for free. We don't need to rebuild all the pages everytime a new one is added. The author, date of creation and date of revision are extracted from git information. The index is generated automatically, so adding a recipe is literally just adding a markdown file in src/. The deployment system uses rsync to push only newer data to the server. There is a tag system that you can add at the end of each recipe file. Tag pages are generated statically that contain all recipes with a given tag. It introduces more HTML template files, though. To build website, type make build To deploy it, make deploy To clean everything, make clean --- example.md | 36 ------------------------------------ 1 file changed, 36 deletions(-) delete mode 100644 example.md (limited to 'example.md') diff --git a/example.md b/example.md deleted file mode 100644 index dfb3d05..0000000 --- a/example.md +++ /dev/null @@ -1,36 +0,0 @@ -# This is the dish title - -If necessary, provide a very brief description of the dish in one or two sentences. -For most dishes, this will be unnecessary. -If there is a title image of this dish, it should be above this paragraph. -You may also include prep/cook time and the number of servings as below: - -- ⏲️ Prep time: 10 min -- 🍳Cook time: 30 min -- 🍽️ Servings: 4 - -## Ingredients - -- List the ingredients -- in an unordered list -- similar to this. -- List amounts if necessary. -- Put (optional) at the end of optional ingredients - -## Directions - -1. Now using an ordered list, -2. give the directions to prepare the dish. -3. Do **not** add unnecessary blank lines between items. -4. If necessary, -5. an image can be included between some directions if needed to explain something particular. -6. But that should be kept to a minimum to reduce bandwidth and aid in simplicity. - -## Contribution - -Here, just put your name and links to yourself (maybe a website or donation link) if you want. -You may say "Anonymous" or a screenname if desired. -If you add something substantial to an already existing recipe (including and image) you may add your name below with the contribution in parens. - -- Luke Smith - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate) -- Luke Smith (photo credit) - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate) -- cgit v1.2.3 From 5da3d4fa492b9b33a88e1cbdffc674c45debe74b Mon Sep 17 00:00:00 2001 From: Sylvain Gauthier Date: Sun, 14 Mar 2021 17:00:36 +1100 Subject: re-add/amend example.md and README.md --- example.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 example.md (limited to 'example.md') diff --git a/example.md b/example.md new file mode 100644 index 0000000..a53988f --- /dev/null +++ b/example.md @@ -0,0 +1,42 @@ +# This is the dish title + +If necessary, provide a very brief description of the dish in one or two sentences. +For most dishes, this will be unnecessary. +If there is a title image of this dish, it should be above this paragraph. +You may also include prep/cook time and the number of servings as below: + +- ⏲️ Prep time: 10 min +- 🍳Cook time: 30 min +- 🍽️ Servings: 4 + +## Ingredients + +- List the ingredients +- in an unordered list +- similar to this. +- List amounts if necessary. +- Put (optional) at the end of optional ingredients + +## Directions + +1. Now using an ordered list, +2. give the directions to prepare the dish. +3. Do **not** add unnecessary blank lines between items. +4. If necessary, +5. an image can be included between some directions if needed to explain something particular. +6. But that should be kept to a minimum to reduce bandwidth and aid in simplicity. + +## Contribution + +Here, just put your name and links to yourself (maybe a website or donation link) if you want. +You may say "Anonymous" or a screenname if desired. +If you add something substantial to an already existing recipe (including and image) you may add your name below with the contribution in parens. + +Note that your commit name will be used to sign the recipe, so for full +anonymity either commit with a name that can't be traced back to you, or ask +someone else to commit for you. + +- Luke Smith - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate) +- Luke Smith (photo credit) - [website](https://lukesmith.xyz), [donate](https://lukesmith.xyz/donate) + +;tags: tag1 tag2 tag3 (see README for tag guidelines) -- cgit v1.2.3