Skip to content

Support Markdown formatting in recipe descriptions and instructions #217

Open
@maninthemiddle01

Description

@maninthemiddle01

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or requestrequestRequested by users

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions