Skip to content

Add optional description(s) to the recipe syntax #10

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.

Sign up for GitHub

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

Draft
norm wants to merge 1 commit into
base: expand-syntax-docs
Choose a base branch
from
Draft

Add optional description(s) to the recipe syntax #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions dr.syntax/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,13 @@ absolute URL if the media files are stored elsewhere such as on Wikipedia.)
"gluten free",
...
],
"description": [
{
"type": "text/markdown",
"content": "This is *my* recipe for mashed potatoes.\n"
},
...
]
"ingredients": [
{
"name": "large potato",
Expand Down Expand Up @@ -115,7 +122,16 @@ The **recipe object** contains:
* `attributes` — _optional_, an array of strings which represent aspects of
this recipe (such as "gluten free") which can be used for searching and
filtering
* `description` — _optional_, an array of objects representing a narrative
description of the recipe which contain:

* `type` — _required_, a string representing the
[media type](https://en.wikipedia.org/wiki/Media_type) of the
description (eg "text/plain", "text/html")
* `content` — _required_, the description, formatted as _type_

If there is only one description object and it is plain text, the object
can be collapsed to a string.

The **ingredient object** contains:

Expand Down