sudar/wp-plugin-in-github

Handle Screenshots

sudar opened this issue · 5 comments

sudar commented

When the readme is converted to markdown format handle screenshots as well

wedi commented

Yes, it would definitely great to show optional screenshots in README.md as they are in the rendered readme.txt in the plugin directory. It's somewhat awkward to have a section named "Screenshots" with a numbered list but without any images in your README.md.

Markdown allows to embed images via !\[Alt Text\]([github raw] url of image). Your toolkit already handles the WP repo assets folder and the images are always named screenshot-([0-9]{1,}).(jpg|png). So with some awesome RegEx magic (that - unfortunately - exceeds my knowledge in this area yet) it should be possible to consider screenshots in the converter.

I just did a quick and dirty hack to remove screenshots manually added to the README.md: 4f7785d.

Duplicate: #9

sudar commented

I am in the final stages of fixing it. I just came back with a solution that works for me. But I am in the process of testing it more so that it can be made generic enough so that it will be useful for others as well.

Here is the summary of what I did. I added some awk magic in readme-converter.sh(thanks for #10 :) ), which when converting .txt to .md, will convert normal screenshot list into markdown image format. It will revert markdown image format to normal list when doing .md to .txt.

You can see it in action at https://github.com/sudar/bulk-delete

Would you be interested in testing it? Would be nice to get some more eyes on it before I merge it into master.

wedi commented

Sure. I can test it.

sudar commented

Sure. I can test it.

Thanks. I have pushed a new branch "screen-shot" with the changes. Can you kindly check them and let me know if you face any issues?

sudar commented

I have merged the changes into the master branch.