TiddlyWiki Static Publish

tags:: #TiddlyWiki, #Github Actions link:: https://github.com/bmann/tiddlywiki-static-publish project:: active

  • This script actively runs my #FoodWiki, usually through Publishing a static TiddlyWiki from mobile
  • It takes a single file #TiddlyWiki and the TiddlyWiki/Static Sites process in GitHub Actions so that you have individual pages and direct links for all tiddlers in your wiki
  • README
    • A set of scripts designed to work with Github Actions for Static Site Publishing for TiddlyWiki.
    • Overview
      • Update a single file TiddlyWiki and check it into git, and the Github Action here will generate a static version of the site.
      • This static site will have your default home page at index.html (at the root of your site) and all of the tiddlers will be at YOURNAME.github.io/REPO/my-tiddler.html, or example.com/my-tiddler.html if you have mapped a custom domain.
    • Instructions
      • Fork this repo
      • Edit the shadow tiddler $:/core/templates/static.template.html to remove the static/ prefix in the macro tv-wikilink-template
      • Check in your own single file wiki — the default build.sh expects it to be named index.html but you can call it whatever you like
      • Add a gh-pages branch — can be empty, it is overwritten on publish
      • Set Github Pages settings to publish from the gh-pages branch
      • If you set up your single file wiki with a Github Git saver, whenever you save, a new version of your site will automatically be built and published.
    • Acknowledgements