README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# tg2md

This script parses output from Telegram channel and converts each post to 
jekyll-applicable post in markdown.

Telegram Desktop creates JSON file, as well as different directories containing
multimedia, photos, etc. This script creates new directory and populates it with
formatted posts ready to publish.

## basic usage

Firstly you need to export your channel history from Telegram Desktop app.
This could be done from three dots menu. Then popup menu appears, where
you can choose what data you want to export. The script currently supports
only photos, voice messages and audio files.

![tg-export](docs/tg-export.png)

In format menu you should specify 'Machine-readable JSON' file and then
locate to directory of your desire.

To convert your posts to markdown files you need to run `tg2md.py` program
which takes path to your `result.json` file as first argument.

```console
$ python tg2md.py path/to/result.json
```

By default it will create `formatted_posts` directory in your current directory
and populate it with markdown files. If you want to specify other location,
use `--out-dir` flag

```console
$ python tg2md.py result.json --out-dir path/to/post/output
```

Also if your jekyll directory storing media files in folders other than `photos`
and `files`, you should specify their location with `--photo-dir` and
`--media-dir` flags respectively. Note that they only change links in the
markdown files.

## todo's

- replies
- single/muliple tags
- forwarded posts
- custom post header