frictionlessdata / datapackage-js

A JavaScript library for working with Data Package.
http://frictionlessdata.io/
MIT License
43 stars 15 forks source link

Generate human-readable display of a Data Package #119

Open nichtich opened 9 months ago

nichtich commented 9 months ago

Class Package should get methods such as .html(), .markdown() and/or .text() to generate a human-readable description of a the package. I'd use ejs form implementation, but any other slim HTML template engine is fine as well.

Use case: generation of a human-readable description for data publication. I refuse to write the same information twice (as plain text description and as JSON file) and in doubt I'd always prefer the first because of accessibility and because repositories require a description anyway. The data package specification recommends a README.md.


Please preserve this line to notify @aivuk (lead of this repository)

nichtich commented 9 months ago

Looks like there was something similar with https://github.com/frictionlessdata/datapackage-render-js and https://github.com/datopian/datapackage-views-js but http://datahub.io/docs/features/views/ is down so I cannot judge. Moreover the human-readable display should be a static file.

See https://github.com/gbv/k10plus-ddc/tree/main/publication for an examples I quickly hacked together (datapackage.json => README.md)