Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0002 Recipe introduction section #95

Merged
merged 2 commits into from
Nov 23, 2024

Conversation

pelted
Copy link
Contributor

@pelted pelted commented Aug 28, 2023

Rendered

From CONTRIBUTING.md

This PR is a proposal submission to add support for an introduction section to a recipe and to facilitate defining ingredients at the top of a .cook file.

See discussion #46

@pelted
Copy link
Contributor Author

pelted commented Aug 28, 2023

I was just looking at cooklang-swift and maybe it would be easier to do pre-defined ingredients with the comment syntax.

>> source: https://www.joshuaweissman.com/post/easy-authentic-thai-green-curry

== Homemade Thai Green Curry deserves respect when making it.
== Good thing it's actually very easy and just requires a little elbow grease.

-- @coriander seeds{2%tsps}
-- @cumin seeds{1%tsps}
-- @white peppercorn{1%tsps}

First step goes here

@dubadub dubadub changed the title Adding a proposal for a recipe introduction section 0002 Adding a proposal for a recipe introduction section Nov 5, 2024
@dubadub dubadub self-assigned this Nov 5, 2024
@dubadub dubadub changed the title 0002 Adding a proposal for a recipe introduction section 0002 Recipe introduction section Nov 5, 2024
@pubmania
Copy link

pubmania commented Nov 19, 2024

I think I can see the benefit of an introduction section but having ingredients block separated out is lost on me. Would you be able to explain why this may be desirable?

One of the things that attracted me to cooklang was the fact that I dont have to write ingredients and steps separately and then every time jump between two sections. On the presentation layer (UI) it can be and is presented with two separate blocks but at the time of writing the .cook file or in my case the cooklang codeblock, I think it will add unwanted complexity but perhaps there may be an advantage to this approach which I am unable to grasp, hence the question.

@dubadub
Copy link
Member

dubadub commented Nov 20, 2024

I think there're two separate proposals here which should be discussed separately. I think it's a valid use case to have some recipe description. That can be done now with notes or we can add canonical description tag into #105.

---
source: https://www.joshuaweissman.com/post/easy-authentic-thai-green-curry
description: |
    Homemade Thai Green Curry deserves respect when making it.
    Good thing it's actually very easy and just requires a little elbow grease.
---

First step goes here

or

---
source: https://www.joshuaweissman.com/post/easy-authentic-thai-green-curry
---

> Homemade Thai Green Curry deserves respect when making it.
> Good thing it's actually very easy and just requires a little elbow grease.

First step goes here

@dubadub
Copy link
Member

dubadub commented Nov 20, 2024

As for the listing ingredients in front, I don't think that I understand the motivation...

@dubadub dubadub merged commit 1fded89 into cooklang:main Nov 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants