Should we prescribe/suggest a Markdown flavour?

[hoijui]

If the readme field links to README.md we would require/suggest.check-whether that to adheres to a certain Markdown flavor (~= specific set of allowed syntax and extensions).

Pro

The benefit of this would be, that consumers of OKH data would be able to assume/know, that they can render a projects documentation properly/as intended by the creators.

Likely candidates for that standard-flavor

• GitHub-Flavored Markdown (gfm)
• MarkDoc
• CommonMark

Alternative

Each project may define which standard they use

[moedn]

not sure about this.

• I don't expect the scene to follow one markdown flavor
• the readme field may link to a source that doesn't even use markdown (e.g. mediawiki, a blog, a hackaday page)

[hoijui]

The reason for this request is, to be able to nicely visualize the text. but indeed, it might simply make most sense, to leave it completely open, and have the consumers of the data use some heuristics/detection library, which figures out the most likely candidate of MD flavor in each case, and use that (or say, convert it to whatever flavour that consumer wants to use) before converting to e.g HTML.