flauschtrud / broccoli

Broccoli is a free recipe app that lets you build your own personal recipe collection and helps you cook in a more eco-friendly way.
GNU General Public License v3.0
70 stars 6 forks source link

Support Markdown formatting in recipe descriptions and instructions #217

Open maninthemiddle01 opened 4 months ago

maninthemiddle01 commented 4 months ago

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:

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:

OrsonDeWitt commented 3 months ago

I agree, this would be awesome!

meersjo commented 3 months ago

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 commented 2 months ago

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

flauschtrud commented 2 months ago

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