Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidag/tiddlywiki-migrator
Export tiddlers from a single-file html TiddlyWiki, "classic" or "modern", to Markdown.
https://github.com/davidag/tiddlywiki-migrator
data-migration markdown tiddlywiki tiddlywiki5
Last synced: about 19 hours ago
JSON representation
Export tiddlers from a single-file html TiddlyWiki, "classic" or "modern", to Markdown.
- Host: GitHub
- URL: https://github.com/davidag/tiddlywiki-migrator
- Owner: davidag
- License: mit
- Created: 2020-04-30T12:36:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-07T13:31:38.000Z (about 1 year ago)
- Last Synced: 2023-11-07T14:37:53.632Z (about 1 year ago)
- Topics: data-migration, markdown, tiddlywiki, tiddlywiki5
- Language: Makefile
- Size: 73.2 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
1. Clone this repository.
2. Copy your single-file html TiddlyWiki (2 or 5) in your cloned repository.
3. Rename your TW html to `wiki.html`
4. Export your tiddlers:
```
$ make
```
5. 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](https://tiddlywiki.com).
### 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](https://davidalfonso.es/posts/tiddlywiki-to-markdown) with some more detail.