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

Support Markdown formatting in recipe descriptions and instructions #217

Open
maninthemiddle01 opened this issue Apr 21, 2024 · 4 comments
Labels
feature New feature or request request Requested by users

Comments

@maninthemiddle01
Copy link

As a user of the Broccoli recipe app, I would like to see support for Markdown formatting in recipe descriptions and instructions. This would allow users to add rich text formatting to their recipes, making them more visually appealing and easier to read.

Motivation:

Markdown is a lightweight and easy-to-use formatting syntax that is widely supported in many applications. By supporting Markdown in Broccoli, users would be able to add formatting such as:

  • Headers (e.g. # Heading) to break up long blocks of text
  • Bold and italic text (e.g. **Bold** and *Italic*) to emphasize important information

This would enhance the overall user experience of the app.

Proposed Implementation:

To implement Markdown support in Broccoli, I suggest the following:

  1. Add a Markdown parser to the app's backend to convert Markdown syntax to HTML.
  2. Update the recipe description and instruction fields to support Markdown input.
  3. Render Markdown-formatted text in the app's UI, using the parsed HTML output from the backend.

Benefits:

  • Improved user experience: Users will be able to create more visually appealing and readable recipes.
  • Increased flexibility: Markdown support will give users more control over the formatting of their recipes.
@flauschtrud flauschtrud added feature New feature or request request Requested by users labels Apr 29, 2024
@OrsonDeWitt
Copy link

I agree, this would be awesome!

@meersjo
Copy link

meersjo commented Jun 5, 2024

I would definitely like (a subset of) markdown in the description field, as well as the as yet nonexistent additional notes field :-)

It could be good in the ingredients and recipe fields as well, for instance it would be useful if a recipe contains multiple sub-preparations; but I can also see it getting in the way of the automatic bulleting and maybe even the ingredient scaling... it'd probably have to be a very limited subset there.

@asiag0
Copy link

asiag0 commented Jun 27, 2024

being able to export and share markdown formatted recipes would be a logical extension of this feature.

@flauschtrud
Copy link
Owner

being able to export and share markdown formatted recipes would be a logical extension of this feature.

I just added another export issue for MD as this one focuses on display and editing within the app: #244

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request request Requested by users
Projects
None yet
Development

No branches or pull requests

5 participants