Josee9988
commented
3 years ago Hey, thanks for your dedication, all the changes make sense and improve the readme.
I used Imgur because It would reduce the bundle size of the package but since this is only for the readme it doesn't matter.
I'll upload a new version for the readme to appear in the upcoming days.
Merging your changes!
Thanks again
small additions and changes for README.md
Description
I had some small fixes and ideas for the README file. I put them into selfsuficient commits, so feel free to cherry-pick only some of them or just ignore it all :)
Additional context
small errors
Found some smal inconsistencies and the example for
MinifyAll.terserMinifyOptionshad syntax errors.git internal links
I belive directly using the images from the
Screenshots/folder would be better, but maybe you had good reason to use imgur?I decided to use absolute links instead of relative ones to make sure they always work, even when viewing the file localy in a text editor or when pulling the file out of its project folder.
I linked to your repository, so the missing image will only work after you merged the commit.
changed image showing right click menu
I felt like the image should show the contextmenu with only this extention active, so a made a new one. The old version also showed some bookmark extention.
image styling
The styling is ignored on the github website and on the the extention site inside VS code, so I felt like it takes up unnececery space. But if you use a MD-viewer that respects this styling, just ignore this commit.
link to list of filetypes
having the supported filetypes listed in multiple places easilie leads to inconsistencies when forgetting to edit one place (which was the case, XML is still missing here) so I added a link to the dedicated section to avoid that in the future. Also makes it a little bit more readable in my opinion.