Show readmes of archives - Githubissues

zopsicle / crai

Cryogenic Raku Archive Index

https://crai.foldr.nl

1 stars 1 forks source link

Show readmes of archives #10

Open zopsicle opened 4 years ago

zopsicle commented 4 years ago

Viewing an archive in the web interface should display the rendered readme of that archive.

Find the file named README or README.* in the archive.
Pass it through Pandoc to convert it to HTML.
Strip any malicious HTML, including data: and javascript: URIs, and store that in the database.

Two remarks:

Storing pre-rendered HTML in the database makes displaying the information faster, which is very important.
Readme extraction failure should not impact extraction of other metadata.