TiddlyWiki 技术文档

1. 安装指南

1.1 安装 Node.js

在安装 TiddlyWiki 之前，首先需要安装 Node.js。以下是不同操作系统的安装方法：

• Linux (Debian/Ubuntu):

  apt install nodejs
  apt install npm
  

• Linux (Arch Linux):

  yay -S tiddlywiki
  

• Mac:

  brew install node
  

• Android: 使用 Termux 安装。

• 其他操作系统: 请参考 Node.js 官方网站。

1.2 安装 TiddlyWiki

在安装 Node.js 后，打开命令行终端并输入以下命令来安装 TiddlyWiki：

npm install -g tiddlywiki

如果安装失败并提示权限错误，请使用管理员权限重新运行命令：

sudo npm install -g tiddlywiki

1.3 验证安装

安装完成后，可以通过以下命令验证 TiddlyWiki 是否安装成功：

tiddlywiki --version

如果安装成功，命令行将显示 TiddlyWiki 的当前版本号。

2. 项目的使用说明

2.1 创建新 Wiki

要创建一个新的 TiddlyWiki，可以使用以下命令：

tiddlywiki mynewwiki --init server

此命令将创建一个名为 mynewwiki 的文件夹，并在其中包含服务器相关的组件。

2.2 启动 TiddlyWiki

创建新 Wiki 后，可以使用以下命令启动 TiddlyWiki：

tiddlywiki mynewwiki --listen

启动后，打开浏览器并访问 http://127.0.0.1:8080/，即可开始使用 TiddlyWiki。

2.3 编辑和创建 Tiddlers

在浏览器中打开 TiddlyWiki 后，您可以开始编辑和创建 Tiddlers。Tiddlers 是 TiddlyWiki 中的基本内容单元，您可以通过界面进行编辑、保存和组织。

2.4 离线保存

如果您希望将 TiddlyWiki 保存为离线文件，可以点击侧边栏中的“保存更改”按钮，或者使用以下命令：

tiddlywiki mynewwiki --build index

3. 项目API使用文档

TiddlyWiki 提供了丰富的 API，允许开发者进行高度定制和扩展。以下是一些常用的 API 命令：

3.1 初始化 Wiki

tiddlywiki mynewwiki --init server

此命令用于初始化一个新的 Wiki，并包含服务器相关的组件。

3.2 启动服务器

tiddlywiki mynewwiki --listen

此命令用于启动 TiddlyWiki 服务器，并在本地浏览器中访问。

3.3 构建离线版本

tiddlywiki mynewwiki --build index

此命令用于构建 TiddlyWiki 的离线版本，生成一个 HTML 文件。

4. 项目安装方式

TiddlyWiki 可以通过以下两种方式进行安装和使用：

4.1 单文件浏览器版本

TiddlyWiki 可以作为一个单独的 HTML 文件在浏览器中使用。用户只需下载 TiddlyWiki 的 HTML 文件，然后在浏览器中打开即可。

4.2 Node.js 应用版本

TiddlyWiki 也可以作为一个强大的 Node.js 应用使用。用户需要先安装 Node.js，然后通过 npm 安装 TiddlyWiki，并使用命令行工具进行初始化、启动和管理。

通过以上步骤，您可以轻松安装和使用 TiddlyWiki，并利用其强大的功能进行个人笔记管理和知识组织。