How to export functional static website

[ILYA Khlopotov]

Hello, 

I am trying to make an edition which would include a set of plugins and few custom tiddlers. This edition need to be exported as a web site. 

The website should act as read-only tiddlywiki. I.e. search and all included Javascript should continue to work. The exported site should have index.html (which would contain all system tiddlers) and a set of separate html files for non system tiddlers. All tiddlers from separate files need to be accessible from index.html.  
Ideally I want to achieve that via tiddlywiki.info file without extra scripts.

I know it should be possible but I cannot understand how to make it work.

I found few examples but they don't do what I need:
- "--rendertiddler","$:/core/save/all","index.html","text/plain"] --- renders everything into a single file -"--rendertiddler","$:/core/templates/static.template.html","static.html","text/plain" --- produces noJS version of wiki I would like to avoid modifying all my tiddlers. I tried exporting using $:/core/save/empty but I don't know how to refer to other tiddlers (exported in html format) in output/static directory. I included the content of tiddlywiki.info in the attachment. 

Any hints or examples of doing something like this?

Best regards,

ILYA

[TonyM]

ILYA,

Perhaps you could layout what you want to achieve with this. 

I do not think there is an exact solution waiting but depending on your objective it may be easy. 

Some notes that may or may not help

• There is a method to externalise javascript 
• If you could host on node there are automatically generated static HTML tiddlers this has being done for tiddlywiki.com
• There are instructions for Generating Static Sites with TiddlyWiki From a folder based wiki (which is what you are doing)
• If you look at the instructions there in you will see the use of tiddler templates $:/core/templates/static.tiddler.html
• In fact you can alter this template to output whatever you want the exported pages to look like. 
  
• Perhaps WidgetMessage: tm-open-external-window could also prove useful. 

Personally I want to simply publish both static (Seperate HTML files) and dynamic tiddlers (in the index.html) to increase search visibility and allow low overhead views of tiddlers, 

is that what you want?

• I would like to generate a full single file wiki (index.html with a splash screen) from a tiddlywiki with a separate static version of every content (non system) Tiddler, 
• however any links there in would point to the actual tiddler(s) in the index.html. 
• Thus searches will see the content of each rendered tiddler in a static version and link to the real tiddlers, 
• but on the first interaction the full wiki loads and thus all the javascript interaction can take place.
• In addition in the interactive wiki provide each tiddler with a button that on clicking opens the static version of that tiddler in a new tab,

I believe the above is achievable with a minor alteration to the appropriate template, and the provision of a view template button to open the static tiddlers separately if desired.

However a full interactive wiki is always the best for users, the splash screen keeps them waiting while it loads and adding a CDN like cloudflare on the front improves performance.

If the reason is your regular tiddlers are images or videos and your wiki is thus too big, perhaps you need to investigate;

• External Attachments Plugin

• ExternalImages

Or even using other html methods https://www.w3schools.com/tags/tag_object.asp

Regards

Tony

[ILYA]

Thank you Tony for extended reply.


I got one idea to try. I am thinking about implementing a custom syncadapter. The build script would generate index.json which would be static and served by http server and used by `getSkinnyTiddlers(callback)`. The syncadapter would know how to retrieve index.json and tiddlers html from http server.

Best regards,
ILYA

--
Sent from my Android device with K-9 Mail. Please excuse my brevity.

[ILYA]

Also since WebServer API ( https://tiddlywiki.com/#WebServer%20API%3A%20Get%20All%20Tiddlers ) uses http get it should be possible to mimick it with the right folder structure. This should work for my use case (read-only web site). In such case even custom syncadapter is not needed.

[Mohamed Sh. Amin]

Hello ILYA,

Did you manage to get a working solution for your requirement? I tried to use

"--rendertiddler","$:/core/save/all","index.html","text/plain"

and I got also a single HTML file.

What I'm thinking now is:-

1- some working solution with tiddlywiki.info (but after TonyM replay I think there is not a direct solution).

2- use TiddlyServer API.

3- create a script to split the single HTML file to separated files (hope not to go this way)

Regards 

[ILYA]

Hello Mohamed,

Not yet. I am planing to work on it this week.

Best regards,
ILYA

[ILYA Khlopotov]

Hello Mohamed,

> Hello ILYA,

> Did you manage to get a working solution for your requirement? I tried to use

> "--rendertiddler","$:/core/save/all","index.html","text/plain"

> and I got also a single HTML file.

Just wanted to provide an update from my side. I decided to implement custom sync adaptor. My current code is in the attached file.

It works as expected if I have following files in the root directory of a web server

index.html --- built using edition which includes my iilyak/static plugin

tiddlers.json

```

[
  {
	"title": "HelloThere",
	"tags": "FirstTag [[Second Tag]]",
	"fields": {
		"my-custom-field": "Field value"		
	}
  }
]

```

tiddlers/HelloThere

```
{
  "created": "20191128223719980",
  "modified": "20191128223730628",
  "tags": "FirstTag [[Second Tag]]",
  "text": "BlaBla",
  "title": "HelloThere",
  "type": "text/vnd.tiddlywiki",
  "my-custom-field": "Field value"
}

```

In the next couple of days I would be trying to find a way how to generate independent json files and how to generate tiddlers.json

Best regards,

iilyak

--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/1253387f-4f3c-4adf-9179-5fd31277cf4d%40googlegroups.com.

[Mohammad]

Hi Ilya,

 This is wonderful solution! I would much appreciate if you kindly instruct how

to use the plugin and what is the relevant tiddlywiki.info 

--Mohammad

To unsubscribe from this group and stop receiving emails from it, send an email to tiddly...@googlegroups.com.

[ILYA]

Hi Mohammad,

Some docs available on demo site here https://iilyak.github.io/tiddlywiki-splitweb/

The code is here
https://github.com/iilyak/tiddlywiki-splitweb

Unfortunately it doesn't work with latest tw5 since the sync adapter interface has been changed.
I am slowly working on fixing the plugin.

Best regards,
ILYA

[Mohammad]

Many thanks ILYA and sorry for this late reply!

On Saturday, May 2, 2020 at 1:15:20 AM UTC+4:30, ILYA wrote:

Hi Mohammad,

Some docs available on demo site here https://iilyak.github.io/tiddlywiki-splitweb/

The code is here
https://github.com/iilyak/tiddlywiki-splitweb

I got the code and doc! 

Unfortunately it doesn't work with latest tw5 since the sync adapter interface has been changed.
I am slowly working on fixing the plugin.

Wonderful! 

Best regards,
ILYA

Cheers

Mohammad