Script update for references and checks #770
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I really like this idea. Looks good. What more work does it need? |
|
Just wanted to confirm the location of the files and that the html was good. Also, should I remove the reference/index.md and just use the REFERENCES.md file perhaps? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the update_readme.py to keep a REFERENCES.md and a CHECK.html file updated.
A working example of the check html file is here: https://jmb.github.io/SuperTinyIcons/CHECK.html - it shows the SVG icon with border=50% so that any that don't fit the circle are easily recognised.
It currently looks for reference images with the same base name as the svg, then checks the images/reference/index.md for the source location and any other reference images that might have a different name. Eventually this check should probably be moved to look at the REFERENCES.md file and the index.md removed.
PR presented for evaluation with the understanding that tweaks will likely need to be made! Thanks!