datopian / datahub-qa

:package: Bugs, issues and suggestions for datahub.io
https://datahub.io/
32 stars 6 forks source link

Data package description markdown not rendered on DataHub package pages #240

Closed zaneselvans closed 6 years ago

zaneselvans commented 6 years ago

The data package standard specifies that the data package description attribute should be markdown. However, on DataHub.io these descriptions appear to be rendered as plain text. For an example see this data package.

How to reproduce

Push a datapackage to DataHub that uses markdown in the package's description. View that package on DataHub, and note that the markdown is not being parsed.

Expected behavior

markdown fields would be rendered as markdown (with links, formatting, lists, etc.) when displayed on DataHub.

Additionally, apparently true multi-line strings aren't allowed within JSON files, but using \n\n style line breaks in the description of the data package also doesn't get rendered, so it ends up being one big blob of text.

anuveyatsu commented 6 years ago

@zaneselvans thanks for submitting this. It looks like the issue was fixed now. Please, re-open if not.