Skip to content

Commit d73e8bc

Browse files
committed
Print warning in bold text; add note about performance
1 parent 57d63b8 commit d73e8bc

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
Migrate your TiddlyWiki5 (Node.js version) tiddlers (`.tid` files) to Markdown tiddlers (`.md` files for markup plus `.md.meta` files for meta information).
44

5+
56
## Markdown in TiddlyWiki
67

78
[TiddlyWiki](https://tiddlywiki.com/) uses its own [WikiText](https://tiddlywiki.com/#WikiText) markup language. While this is the natural first choice when using TiddlyWiki, it's also possible writing tiddlers in Markdown using the official [Markdown Plugin](https://tiddlywiki.com/#Markdown%20Plugin). Markdown has the advantage that it's used in many places (p.e. GitHub, GitLab, BitBucket, StackOverflow, Reddit) and is supported by many editors, parsers and other tools. When you often copy tiddlers (or parts of them) to other websites or when you edit/process your `.tid` files with tools except TiddlyWiki itself, it might make sense to write your tiddlers in Markdown or migrate those already written in WikiText to Markdown. This is what `tid2md.py` was made for.
89

10+
911
## Installation
1012

1113
Just clone this repository and copy/symlink `tid2md.py` to a directory in your `$PATH`.
@@ -22,13 +24,14 @@ cd ~
2224
test -f tid2md.py || PATH=~/.local/bin:"$PATH"
2325
```
2426

27+
2528
## How to use tid2md.py
2629

2730
`tid2md.py` is a Python script to be run in a terminal. It takes a list of `.tid` files as input parameter. This means that it cannot be used with a single-HTML-file TiddlyWiki. It only works with a [Node.js TiddlyWiki](https://tiddlywiki.com/#Installing%20TiddlyWiki%20on%20Node.js) which stores every tiddler as a separate `.tid` file on your disk.
2831

29-
⚠ Warning: This script was only tested by myself using my own tiddlers. Please test it on a copy of your wiki and check if the migrated tiddlers look like expected.
32+
**Warning: This script was only tested by myself using my own tiddlers. Please test it on a copy of your wiki and check if the migrated tiddlers look like expected.**
3033

31-
Migrate all `.tid` files:
34+
### Migrate all `.tid` files:
3235

3336
```sh
3437
cd path/to/wiki/tiddlers
@@ -46,3 +49,8 @@ Tiddlers with tables are skipped by default because Markdown tables are lacking
4649
The `--delete` option makes the script delete the original `.tid` files after a successful migration because otherwise you would end up with two versions of the same tiddler.
4750

4851
Run `tid2md.py --help` for more options.
52+
53+
54+
## Performance
55+
56+
On my laptop, it takes about 370 ms to migrate 503 tiddlers (+ skipping 146 tiddlers).

0 commit comments

Comments
 (0)