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
Tidy Readme, add socials, move version history #247
base: master
Are you sure you want to change the base?
Conversation
NB: there is a copy of Readme (not updated) in the theme root, socials.toml should probably be filled with dummy data or moved to example site, version-history.md can be merged with CHANGELOG.md?
Question: is it possible to move all language data from I'll do it later in this pull request if I can find all the references to the weekdays, but as I don't know the code inside out, just thought I'd check. |
Both READMEs need to be updated, one for the hugo theme and one for GitHub.
I agree with placing dummy data to
And I also agree to place the
Since we use |
There were 2 copies of README.md, only keep 1. Merge version-history.md with CHANGELOG.md (could use further tidying). Some minor English grammar corrections.
…ative docs folder link
Why is there a massive ## Tags section in the README? Demote to minor section near the end, formatted as it is in the theme.toml to allow easier copypasta when adding/removing tags (which are now in alphabetical order).
…uplicate README.md README.md duplicate required because of GitHub vs. GoHugo.io, according to g1eny0ung. mailto: skype: tox: tel: and Whatsapp all need testing.
…from USA USA formats dates as MM/DD/YYYY, it annoys me, as an international/UK English speaker. International and UK standard is DD/MM/YYYY; see https://www.quora.com/Why-are-these-2-different-date-format-used-dd-mm-yy-and-mm-dd-yy-They-sometimes-cause-confusion
A lot of repetition; wondering if it's worth/possible to make i18n.html and referring to that whenever this is required. Hope it doesn't slow site loading. Next step: try and move lang.toml files to their own folder.
Question: is it possible to put the whole i18n block within its own
I found this resource: https://www.w3schools.com/howto/howto_html_include.asp, but it seems to use JS to "include" other html, which is undesirable - it will probably break as soon as someone uses a legacy browser or NoScript. There must be a built-in way to do it in HTML or Hugo... EDIT: Hugo should be the way to go, as the consensus from my research is that embedding repeated snippets of HTML requires either preprocessing (via PHP, Hugo or somesuch) or postprocessing, via JS in the user's browser. Maybe via EDIT: Found the solution, will implement later: partials |
Need to figure out if it's possible to reference within single.html and summary.html without extra JS, to save 3x37 lines.
Just realised the |
…ted HTML; start fixing docs/README.md Apparently / means "git repo root" in the markdown files, so docs/README.md should work now that I've added a / to a couple paths...?
Relative links in |
PWA won't work yet; needs service worker JS Favicons: https://favicomatic.com and https://www.bricelam.net/ImageResizer/ PWA resources: https://web.dev/themed-omnibox/ https://web.dev/add-manifest/ https://discourse.gohugo.io/t/solved-is-it-possible-to-use-site-variables-in-manifest-json/14018/8 https://techformist.com/add-pwa-hugo/ https://blog.jeremylikness.com/blog/implement-progressive-web-app-hugo/ https://gohugohq.com/howto/go-offline-with-service-worker/ https://github.com/wildhaber/offline-first-sw
I'm sorry I haven't followed this project for a long time. I noticed that docsify now has this https://docsify.js.org/#/configuration?id=homepage, which allows us to remove |
This is related to go template. Hugo uses the native go template pkg to organize and render htmls. |
Uh-oh. I implmented the block as a partial which sounded like it would work (but I haven't figured out how to test it, as I'm not sure how to change my locale for a test-site). Wondering if I've broken it? I'm currently trying to get the time/energy to go through another branch I've got and make all JS load locally (my use-case involves offline websites, IPFS, and not wanting to depend on someone else's CDN). Thank you for the heads-up about the Readme! I'll change that, too |
…mprove-readme # Conflicts: # docs/README.md
Pulled the latest changes into this branch; will do some testing. |
# Conflicts: # docs/README.md
Improve security by verifying SubResource Integrity (SRI) of Javascript delivered via remote CDN. Generated via https://www.srihash.org/ (alternative types, SHA-256 and SHA-512 are also available)
... in preparation for replacing remote CDN calls with local/relative URL calls.
Test NoScript warning in header, add Telegram sharing, Windows Explorer "Thumbs.db" to gitignore (in case of images)
Changelog and params info added, too.
... hugo serve -D just doesn't display them when testing locally (Hugo v0.96) [BUG?]
…roduction # Conflicts: # README.md # theme.toml
Hugo Easy Gallery is better implemented as a universal Hugo plugin, and loaded alongside a main theme via the site config.toml As such, Hugo Easy Gallery content is moved to https://github.com/Darthagnon/hugo-easy-gallery and all code and assets related to it have been removed.. Functionally identical, it just means less repeated code, and everyone can use it! This brief experiment got me started on it, though!
# Conflicts: # README.md # layouts/_default/single.html
shorten allTags shorten allCategories switchTheme change "flip" to "About" rss /Subscribe! check "update at" (for languages I can grok) Groups
Re-add accidentally deleted YouTube thumbnail, Twitter screenshot, Instagram picture, Vimeo thumbnail. Add relative links to rich-content-offline.md
Converted using Paint.NET
See Changelog.md for relevant links. May be possible to adapt this XSL for the Tags XML? TODO: Change branding, add logos, relevant links to rss.xsl
So... er... I added a bunch of stuff @g1eny0ung. Most visible changes are:
What do you think? I'll be pushing all these changes to my blog shortly, where you can see how they work: https://robot-one.github.io |
Update: I've pushed the changes to my site if you want to see them. It's not perfect, now that I have a chance to see it in production Known issues, that aren't yet listed
|
You've changed so much that I don't have a lot of energy to review these. 😢 This PR has been open since last year, and I noticed that the comments that were once at the beginning were not processed, so I couldn't merge this PR directly. May I suggest breaking this big PR into smaller PRs? It would be more helpful to track each new feature. |
Hey, sorry for the overwhelming amount of things. I'll try and split it up sometime this coming week. tbh I suspect it looks worse than it actually is - I worked with 2-3 branches, "intended" for features, but then a couple of them the features didn't work, so I just did an undo and merged in small changes to the main branch (which is now far beyond just improving the readme). If I can figure out git, I'll be splitting it roughly into:
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Bad bot. I'm still working on it, and working on my website. Got some more things I've been experimenting with on another theme and fixes I want to implement. And I've (sorta) learned how to cherrypick commits, which I'll have to do to split it up again 😟 Wish I could get my head around organising my pull request. Can't figure out the best way to split it up, might just have to make my version a hard fork. I merged all my branches with a hundred or so commits into one, so as not to open loads of pull requests :'( |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
NB: there is a copy of Readme (not updated) in the theme root, socials.toml should probably be filled with dummy data or moved to example site, version-history.md can be merged with CHANGELOG.md?