Skip to content
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

Jump to bottom

Show readmes of archives #10

Open
zopsicle opened this issue Dec 31, 2019 · 0 comments
Open

Show readmes of archives #10

zopsicle opened this issue Dec 31, 2019 · 0 comments
Labels
crai feature

Comments

@zopsicle
Copy link
Owner

zopsicle commented Dec 31, 2019 •
edited
Loading

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

  1. Find the file named README or README.* in the archive.
  2. Pass it through Pandoc to convert it to HTML.
  3. 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
crai feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zopsicle