readme.so
readme.so copied to clipboard
octokatherine
Importing md file
It would be very useful if we can upload a md file that is also has been created in the readme.so.
This is a pretty interesting feature, but I believe the implementation needs to be carefully considered. How would we recognise the current sections from the imported README, compare titles or add metadata comments to the sections? What if the title was changed, we would need to treat it as a custom section, therefore this feature would always require the work in #6 to be completed first. There are also some sections that do not have a specific title. If we ended up adding some sort of comments to the sections to identify later, this would only be present in new README files, imports of older files would generate only custom sections. @octokatherine what is your opinion regarding this?
I think a good path forward would be to complete #6 first for custom sections, then parse the readmes for titles.
We should make it clear that it is intended to be used for md files that were created with readme.so, or at least formatted the same (h2's for headers)
When we implement this, it would be great if the user could either upload the file or paste the file contents in. I believe more people use the copy functionality than the download functionality currently.
I can pick this up once #6 is closed, if that is okay with you. We can always discuss the smaller details when development starts.
Yes, although I will only be able to pick it up next week. I was waiting for the custom sections development, will that need to be implemented in the context of this feature?
Hey @octokatherine, I'm currently working on this. Do you have an icon for the import and paste buttons? Also, I will only add translations to PT and EN, the rest will need to be done either at a later date, or by other contributors once I open the PR. Is that okay?
@jose-vale Are you still working on this?
I started working on it, but have not had the time lately. Do you want to pick it up?
@jose-vale Are you still working on this?
I started working on it, but have not had the time lately. Do you want to pick it up?
Yeah I might work with you on it together. Maybe you can commit your changes you made already to a new branch in your forked github repo and add me as a contributor?
@MicahBCode I've added you to the repo. I don't recall how far along the feature was, but if you need anything, let me know.
In a somewhat related note: a cool and pretty rapid addition could be the one to export the metadata present in the local storage as json to let us export and import our work. Let me know if you are interested I can either open a new issue and I might also be able to work on this.
