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.

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

Migrate to generated HTML page #217

Open
7 tasks
w-m opened this issue Dec 12, 2024 · 0 comments
Open
7 tasks

Migrate to generated HTML page #217

w-m opened this issue Dec 12, 2024 · 0 comments

Comments

@w-m
Copy link
Collaborator

w-m commented Dec 12, 2024

The Markdown version of the repo has grown too long to render correctly on GitHub.

We discussed possible solutions in the MrNeRF Discord. The current idea is to gather the papers in a yaml format. We will use the YAML format from https://github.com/fhahlbohm/awesome-paper-list/tree/main (developed for #91) as the starting point.

The paper list will move under the key "papers-list:". Additionally there will be a key "allowed-categories:" that lists possible paper categories. "category" will be replaces with "categories", a list that can have multiple possible entries.

There will be an option to add new papers with the provided arxiv_paper_extractor.py script without manual copy-pasting.

  • convert current papers list to YAML with (https://github.com/fhahlbohm/awesome-paper-list/tree/main), and changes listed above for the YAML format, commit YAML to repo
  • create github.io page host
  • create pages for rest-of-awesome-list (tools etc)
  • create readable HTML style for paper list page
  • python script to render html from yaml with readable style (from generate_html.py)
  • github action to generate and host html
  • github action to check adherence of YAML format in pull requests

General notes:

  • enforce arxiv links to be in the same style (https vs http, arxiv.org vs browse.arxiv.org, .pdf vs missing)
  • add arxiv ID to YAML entry
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant