TiddlyWiki Migrator

TiddlyWiki Migrator is a set of scripts put together to automate the migration from a TiddlyWiki (TW). It allows to export all tiddlers in a single-file HTML TiddlyWiki to multiple markdown files (one per tiddler), excluding system tiddlers.

Dependencies

Node.js (tested with v10.4.0)
Npm (tested with 6.1.0)
Pandoc (tested with 2.2.1)

Usage

Clone this repository.
Copy your single-file html TiddlyWiki (2 or 5) in your cloned repository.
Rename your TW html to wiki.html
Export your tiddlers:

$ make

Convert all your tiddlers to Markdown:

$ make convert

Your tiddlers will be in the markdown_tiddlers directory.

Use case

A TW user has decided to abandon the use of TiddlyWiki. For that, she wants to save all tiddlers as markdown files, one for each tiddler from her TiddlyWiki.

Features

Supports classic (version 2) and modern (version 5) TiddlyWikis.
Supported tiddler formats:
- text/vnd.tiddlywiki (modern TW format)
- text/x-tiddlywiki (classic TW format)
- text/x-markdown
Exports to Markdown using Pandoc using options to conveniently simplify the resulting text.
Exported Markdown files follow a safe-name policy, while keeping the name as similar to the original as possible (this includes translating special vowels to the corresponding simple ones).
Metadata from tiddlers is exported as YFML at the beginning of each Markdown file. Metadata includes: creation date, last modification date, tags, etc.

Motivation

What is TiddlyWiki?

TiddlyWiki "classic" (v2.x) is an offline, self-contained html wiki, where you can create, modify and delete tiddlers.

TiddlyWiki "modern" (v5.x) is a brand new TW which can run just like v2.x or using node.js as a backend service to store/retrieve tiddlers.

No doubt, TiddlyWiki is a useful and interesting piece of software.

You can find more information on the TiddlyWiki web.

What is a tiddler?

A tiddler is composed by:

a title,
a creation date,
a last modification date,
a creator and modifier person name,
zero or more tags,
a text and
a format (e.g. "text/x-tiddlywiki")

Why markdown?

Markdown is a possible tiddler's type (as of new versions of TiddlyWiki).

Markdown format is commonplace on the Internet: in forums, blogs, source code repo platforms, etc.

Markdown files usually end with the .md extension and follow the Markdown text format.

Where can I read more about the process of building this script?

I wrote a post with some more detail.

Node_modules directory needs to be manually moved into the repo's root directory in order for the scripts to run

Thank you for creating this TW migrator. I am very new to coding and node.js so it is quite likely that I ran into the following error because I set things up wrong. This is the error I got when I ran make:

Dependencies OK
Installing TiddlyWiki...
/home/USERNAME/.nvm/versions/node/v18.16.0/bin/npm install tiddlywiki

up to date, audited 2 packages in 392ms

found 0 vulnerabilities
Setting up temporary wiki...
/home/USERNAME/.nvm/versions/node/v18.16.0/bin/node node_modules/tiddlywiki/tiddlywiki.js tmp_wiki --init empty
node:internal/modules/cjs/loader:1078
  throw err;
  ^

Error: Cannot find module '/home/USERNAME/repos/tiddlywiki-migrator/node_modules/tiddlywiki/tiddlywiki.js'
    at Module._resolveFilename (node:internal/modules/cjs/loader:1075:15)
    at Module._load (node:internal/modules/cjs/loader:920:27)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
    at node:internal/main/run_main_module:23:47 {
  code: 'MODULE_NOT_FOUND',
  requireStack: []
}

Node.js v18.16.0
make: *** [Makefile:71: tmp_wiki/tiddlywiki.info] Error 1

I solved this by copying the node_modules directory from the user root directory into the root directory of the repo. Both make and make convert worked after this.

Is this a mistake on my part or is it a genuine issue?

davidag / tiddlywiki-migrator Goto Github PK