diff options
author | Tom Whitwell <tom@whitwell.xyz> | 2018-04-24 20:54:32 +0300 |
---|---|---|
committer | Tom Whitwell <tom@whitwell.xyz> | 2018-04-24 20:54:32 +0300 |
commit | a0df5f598beb1550619d76fe91d4d09592d9d5da (patch) | |
tree | 900deaef633ebb5c1b18a8cd227ffb5c866961cd | |
parent | e9276e87ff8a0ab32952f8fceb54ea951445f922 (diff) |
update readme to clarify some things regarding the appcache
-rw-r--r-- | README.md | 13 |
1 files changed, 10 insertions, 3 deletions
@@ -1,5 +1,4 @@ # Startpage theme for hugo - ## Instructions Create data/links.yml in your site directory @@ -31,9 +30,11 @@ https://tnwhitwell.github.io/hugo-startpage-theme/ ## Offline Use -The theme specifies and includes an appcache manifest for offline use. +The theme specifies and includes an appcache manifest for offline use / quick launch. + +This is always included at the moment, but will be controllable / disableable via `config.toml` eventually. -For content changes to be applied, this manifest must be updated on each build. +For content changes to be applied, this manifest ***must*** be updated on each build. Suggested way to get this updated is by running: @@ -44,3 +45,9 @@ sed -i "s/COMMIT_SHA/${CURRENT_REVISION}/" public/startpage.appcache ``` This will ensure that the manifest is updated on each build so the cache is rebuilt by the browser after building. + +### Fixing a prematurely cached site +If the site is cached before you are ready, either: + +1. add a comment to the generated startpage.appcache (changing one character will work) +2. Empty the cache on your browser, using [Andy Gup's instructions](http://www.andygup.net/deleting-an-html-application-cache/). |