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

added import and export functionality #274

Closed
wants to merge 1 commit into from
Closed

added import and export functionality #274

wants to merge 1 commit into from

Conversation

BrookJeynes
Copy link

@BrookJeynes BrookJeynes commented Feb 22, 2023

CC: @SaadBazaz @Danny-dK @CommunityWorkshop @octokatherine

image

Figure: New buttons in nav bar

README files can now be exported to a JSON file where they can then be imported for later use.

Note: The icons for the import/export will need updating, I was not sure on the procedure for getting new icons so I didn't change them.

Closes #264

@vercel
Copy link

vercel bot commented Feb 22, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
readme-so ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 22, 2023 at 4:15AM (UTC)

@octokatherine
Copy link
Owner

Thanks for taking this on! It wasn't clear to me what the difference between "Export" and "Download" would be. I think ideally we would just add an "Import" button that would be able to take in and parse a markdown file, rather than the intermediate json format.

@BrookJeynes
Copy link
Author

@octokatherine if the titles remain the same then the parsing should be pretty straight forward, the difficulty would come from how to handle the cases when the user has changed the title and there's no section matching that.

What we could do is have comments within the markdown above each section. That way, when we important we can read from those fixed comments and they wont show up in the user md file.

I can take some time to re-implement the download/import to work like so? Open for suggestions though :)

@Danny-dK
Copy link

Danny-dK commented Mar 7, 2023

@octokatherine @BrookJeynes But in the meantime it seems relatively straightforward. If the buttons are identified more like 'import json' and 'export json', then at least people are able to export Json and markdown, and re-import the json to keep working at a later time point when new additions are required. Ideally, md file import would be nice, but as an intermittent solution, this already works quite well.

@BrookJeynes
Copy link
Author

@octokatherine @Danny-dK

I plan on implementing the functionality described in my reply tomorrow. I'll notify you guys once I've pushed the changes.

What we could do is have comments within the markdown above each section. That way, when we important we can read from those fixed comments and they wont show up in the user md file

I'm still unable to add new icons as I'm not sure about the process, @octokatherine could you please describe the process when you get the chance? :)

Thanks,

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

Successfully merging this pull request may close these issues.

Feature Request: Import readme.md feature on website.
3 participants