-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove build artifacts from the repo #41
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done self-reviewing. Hopefully we can test the GitHub Pages action before merging this?
docs/index.css
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just felt like moving these styles out of index.html
<option>gotthard-dark</option> | ||
<option>blinds-light</option> | ||
<option>blinds-dark</option> | ||
<option>greative</option> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will need to automate this list of themes somehow. Maybe we'll make this index.html file a Jinja template?
Do we know why PR-preview (GitHub action) doesn't work? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will need to automate this list of themes somehow. Maybe we'll make this index.html file a Jinja template?
Is this being done in other PR? think I saw another one with jinja templates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @gabalafou, this looks great and helps make this repo a lot more maintainable.
Made a couple of small changes (pushed) and suggestions, if you are happy with these we can merge right away.
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
No, this is still an open problem. The Jinja template in the other PRs is used to generate the theme READMEs, but not the demo index.html page. |
This PR removes all of the generated HTML and CSS from the repo and refactors the build scripts.
There is perhaps an argument for committing built examples to the repo. That way a user can open the demo page from their own local repo into their browser without having to execute any build command first. But we can add that later if we want.
My goal is to make the repo easier to understand by stripping it of everything but READMEs, config files, source code, scripts, and tests.
My ultimate goal is to simplify and automate the process of updating or adding a theme. This PR helps that goal by removing steps 2, 3, and 4 from the list of steps in issue #34. The trade-off that this PR makes to achieve that goal is that the docs/index.html file can no longer be opened locally from the repo and just work (to make it work locally, developers will need to run the
render_html
command). Subsequent PRs will automate steps 5 and 6, so that updating a theme will involve the following steps: