adithya-badidey / tiddlyjam

Transform your TiddlyWiki into static websites and blogs. Inspired by JamStack.

TiddlyJam

TiddlyJam is a CMS and website renderer for TiddlyWiki. Its aim is to render and deploy full-featured, media-rich websites right from the wiki. Visit the website at https://tiddlyjam.com

Features

• Content Management System(CMS)
• Out of the box, beautifully rendered blog & website
• Full support for custom pages
• Uses TiddlyWiki's templating library
• Extensible and modular
• Support for themes
• SEO ready

How to use:

Visit https://tiddlyjam.com/wiki for instructions

Example Websites:

• https://tiddlyjam.com
• https://adithyab.in

Roadmap

• Basic Blog and Page renderer/exporter
• Add full featured text editor from https://github.com/adithya-badidey/TW5-codemirror-plus
• Direct exporter via UI
• Support for media/images
• Support for themes/plugins
• Direct deploy of static website to Github Pages

For help/discussion, please join us on Github discusions: https://github.com/adithya-badidey/tiddlyjam/discussions

Please report bugs at https://github.com/adithya-badidey/tiddlyjam/issues

Thanks and Acknowledgements

This has been possible due to the previous work of numerous people. In particular:

• Jeremy Ruston - the creator of TiddlyWiki
• Mohammad Rahmani - https://github.com/kookma
• Anne-Laure Le Cunff - For their articles on https://nesslabs.com
• Richard William Smith - for https://didaxy.com which formed the initial basis for this.
• Everyone on the TiddlyWiki Google Group

tiddlyjam's Issues

[bug] Page not found

https://tiddlyjam.com/tiddly display a "page not found" error

Customize web site template

I'd like to add template choose from with https://html5up.net/ templates, what would be your advice in code placing for that feature?

Home button should return to root instead of /

From @kookma: For my test on local machine, clicking on home button opens the root folder, I did not test online to see if it open the index.html or not

Improve build process

Code suggested by @kookma

"tiddlyjam":[
"--rendertiddlers",
"[all[tiddlers+shadows]tag[$:/plugins/adithyab/tiddlyjam/live]]",
"$:/plugins/adithyab/tiddlyjam/renderer/base",
".",
"text/plain",
"--render",
"[all[tiddlers+shadows][$:/plugins/adithyab/tiddlyjam/renderer/sitemap]]",
"sitemap.xml",
"text/plain"
]

Followed by tiddlywiki --build tiddlyjam

Also, add a cat tiddlyjam.com > CNAME for fixing the domain name issue.

Add "How to add a new Page section"

Add "How to add a new Page section", maybe with "How does the template/renderer work" section