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

Allow addition of title and brief documentation in Flat Viewer #44

Open
melaniewalsh opened this issue Jun 29, 2023 · 2 comments
Open

Comments

@melaniewalsh
Copy link

Thank you for Flat Viewer! I love this project.

This is a feature request, and I'm not sure how feasible it would be to implement. But we are using Flat Viewer to host and share datasets for the Post45 Data Collective, a repository for literary and cultural data from 1945 to the present. We would love to have the option of adding a title or perhaps some brief documentation to the top of the Flat Viewer page — perhaps this could be customized by including information in a certain way in a README file in each folder in the repository?

Just to give a concrete example, here's what our current framework for hosting the datasets looks like:
Screenshot 2023-06-29 at 11 27 27 AM
vs

Screenshot 2023-06-29 at 11 28 55 AM

We would basically like to add the title, author, and contextual information.

@RandomFractals
Copy link

RandomFractals commented Jul 1, 2023

@melaniewalsh to refine that feature implementation and UX, what if Flat Viewer checked for an .md document with the same filename as your dataset document, loaded and rendered that markdown document with dataset info, data source link, etc. using markdown-it library and plugins?

It can default to loading that dataset info from README.md in the folder containing your data file or parent folder if the corresponding <data-file_name>.md is not found. That would cover cases when a data folder contains multiple data files with different datasets, or when README.md is too broad and large to use for the dataset info header to display.

@melaniewalsh
Copy link
Author

melaniewalsh commented Jul 1, 2023

@RandomFractals Yes, that would be fantastic! Thanks so much for helping to refine this idea. I love the idea of using markdown-it and checking for an .md file with the same name as the dataset (and defaulting to the README.md if not)

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

2 participants