Created by: Chris-Johnston
Fix #479 (closed) , updates the index page with the most recent readme.
Hello, I was looking at fixing issue #479 (closed), when I noticed that the source for https://pwr.github.io/Solaar/ is maintained in the branch gh-pages
, and hasn't been updated in 6 years. I considered either editing the static index page manually (which works, but isn't ideal for maintainability), or using the build script provided to update these files (which wasn't working, missing dependencies on my end).
GitHub pages does support building static pages using Jekyll, so I figured that this would be a much more maintainable solution. The site content can be updated whenever new changes are pushed to master
, without any sort of manual steps.
There is one slight downside to this: The contents of the README.md cannot be used for the index page, so this file was copied. Maintaining changes to both would be something that would have to be kept in mind. I'm not sure a symbolic link would work here. In addition, some of the files had to have Jekyll front-matter added.
I've also rendered a favicon.png
from the logo, since that was one step that was done in the old script.
If this is merged, someone with administrator access to this repo's settings would have to change the source away from the gh-pages
branch.