Closed MoralCode closed 3 years ago
whoops, also gotta make it reusable first
Note on Jekyll: you can in fact embed the HTML inside the Markdown. So keep the old markdown file and then add your script file inside the Markdown file. I'd also keep it separate as its own file (for the script) for better readability.
I'd also keep it separate as its own file (for the script) for better readability.
that's kinda what i did for the main/global script.js
. ideally im trying to move as much of it as reasonable into helper functions inside that script file so the on-page scripts are pretty small. i think part of the reason for splitting it up and having a global script and an in-page script was because some of the in-page stuff needed to be done after the HTML elements loaded, although i dont see why we couldnt move the script.js
's <script>
line to the footer and have it check for the presence of elements with specific ID's and do everything needed to populate that specific one (maybe that would help loading times???)
This could also remove most of the HTML from the markdown. I haven't had a chance to research how jekyll handles the HTML-in-markdown scenario, but IIRC last time i tried something similar (markdown in front matter and using jekyll filters to convert it to HTML) it seemed to be including extra tags that could break our CSS if we end up doing anything super custom. Personally i think it might help make things easier to maintain (both for us and anyone using our code) if pages needing HTML had HTML extensions (or make everything .HTML, since jekyll lets you visit pages without the extension just fine)
Not a huge deal though, just some ideas surrounding your point.
Are you able to do a code review as well?
I agree that we could make everything HTML files. It does seem a bit confusing to have both Markdown and HTML files, though Jekyll is compiled so either works fine for efficiency. Also, yes I can do a little bit of Code Review.
also, do we want to keep the google form for suggesting changes or do we want to just say "email us"? it seems like email may be easier now since it lets us not have to remember to check a separate place for updates but also if we get a lot of updates it might create a lot of email traffic to keep up with
I think we should keep the email us, but we could also list the discord server and say the suggestions channel. But ultimately it's up to you since you are the one to check the email and whatnot.
Am I good to merge this now?
Discord server is being added elsewhere in #5 and #7 i believe. if we have a specific channel for it, then yeah feel free to replace the google form with it if you want
Am I good to merge this now?
I was hoping this could get code-reviewed first as its a fairly major change. i also have a few breaking changes to the airtable DB i want to make first so ill go ahead and make those now before we deploy
This is nearly done. Just needs:
This PR:
home.html
template with an HTML version of the page and merging it with the markdown version. There may be merge conflicts with this and #1, i can resolve these if needed