aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 85559740a68baf0fc409ebeae3fde900d550a3b7 (plain)
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
48
49
# tdwiki

这个仓库支持两种本地使用方式:生成单文件 Wiki,或通过 Node.js 运行目录版 Wiki。

## 环境

需要 Node.js,以及与项目一致的 TiddlyWiki 5.4.1:

```sh
npm install --global tiddlywiki@5.4.1
```

确认安装:

```sh
tiddlywiki --version
```

## 生成单文件

```sh
./scripts/build.sh
```

输出文件为 `dist/tdwiki.html`。构建在临时 Wiki 中完成,不会改写源码目录下的条目。

`tiddlywiki.info` 中也保留了对应的 `singlefile` 构建目标;日常构建建议使用上述脚本,以自动排除仅服务端使用的官方插件并检查输出内容。

单文件包含浏览器端的本地 utilities 插件。

如需指定其他 TiddlyWiki 可执行文件:

```sh
TIDDLYWIKI_BIN=/path/to/tiddlywiki ./scripts/build.sh
```

## 使用 Node.js 运行

```sh
./scripts/run.sh
```

默认地址为 `http://127.0.0.1:10000`。可以通过环境变量修改监听地址和端口:

```sh
TDWIKI_LISTEN_HOST=0.0.0.0 TDWIKI_LISTEN_PORT=8080 ./scripts/run.sh
```

目录版会加载 filesystem、tiddlyweb 和本地 utilities 插件,并直接使用仓库中的 `tiddlers/`、`plugins/` 与 `files/`。