欢迎

欢迎使用 TiddlyWiki，一个任何人都可以使用并永久保存的非线性个人网络笔记本，独立于任何公司。

TiddlyWiki 是一个完整的交互式 JavaScript wiki。它可以作为浏览器中的单个 HTML 文件使用，也可以作为强大的 Node.js 应用程序使用。它具有高度可定制性：整个用户界面本身都是用可修改的 WikiText 实现的。

演示

在 https://tiddlywiki.com/ 了解更多并查看其实际运行效果

开发者文档

开发者文档正在 https://tiddlywiki.com/dev/ 编写中

Pull Request 预览

Pull request 预览由 Netlify 提供

加入社区

用户论坛

Talk TiddlyWiki

作为 TiddlyWiki 的官方论坛，Talk TiddlyWiki 是一个讨论 TiddlyWiki 的地方：寻求帮助、发布新版本和插件的公告、讨论新功能，或仅仅分享经验。您可以通过相关网站参与，或通过电子邮件订阅。

https://talk.tiddlywiki.org/

Google Groups

为了方便现有用户，我们继续运营最初的 TiddlyWiki 群组（自 2005 年起托管于 Google Groups）：https://groups.google.com/group/TiddlyWiki

开发者论坛

tiddlywiki.com/dev 是官方开发者文档
参与 GitHub 上的开发
GitHub Discussions 用于问答和开放式讨论
GitHub Issues 用于报告 bug r
eports 并提出具体、可执行的新想法
参见 Contributing 了解如何为该项目做出贡献的指南。

其他论坛

TiddlyWiki Subreddit：/r/TiddlyWiki5
在 Discord 上聊天：https://discord.gg/HFFZVQ8

在 Node.js 上安装 TiddlyWiki

TiddlyWiki 是一个 SingleFileApplication，易于使用。对于高级用户和开发者，可以使用 Node.js 客户端/服务器配置。该配置也用于构建 TiddlyWiki SinglePageApplication

安装 Node.js
- Linux:
  Debian/Ubuntu:
  apt install nodejs
  可能需要随后执行：
  apt install npm
  Arch Linux
  yay -S tiddlywiki
  (安装 node 和 tiddlywiki)
- Mac
  brew install node
- Android
  Termux for Android
- 其他
  参见 http://nodejs.org
打开命令行终端并输入：
npm install -g tiddlywiki
如果因错误而失败，可能需要以管理员身份重新运行该命令：
sudo npm install -g tiddlywiki (Mac/Linux)
通过输入以下内容确保 TiddlyWiki 已安装：
tiddlywiki --version
- 响应中，您应该看到 TiddlyWiki 报告其当前版本（例如 "5.4.1"。您还可能看到报告的其他调试信息。）
试一试：
1. tiddlywiki myne
  wwiki --init server 创建一个包含服务器相关组件
2. 的新 wiki 文件夹 tiddlywiki mynewwiki --listen 启动 TiddlyWiki
3. 在浏览器中访问 http://127.0.0.1:8080/
4. 尝试编辑和创建 tiddlers
可选地，制作一个离线副本：
- 点击
  
  保存更改 按钮在侧边栏中，或者
- tiddlywiki mynewwiki --build index

-g 标志会使 TiddlyWiki 被全局安装。如果没有该标志，TiddlyWiki 将仅在你安装它的目录中可用。

警告

如果你使用的是 Debian 或基于 Debian 的 Linux，并且尽管已安装 node.js 软件包，但仍收到 node: command not found 错误，你可能需要在 nodejs 和 node 之间创建一个符号链接。请查阅你的发行版手册和 whereis 以正确创建链接。参见 github issue 1434。

Debian v8.0 示例： sudo ln -s /usr/bin/nodejs /usr/bin/node

提示

您也可以这样安装较早的版本：
npm install -g tiddlywiki@5.1.13

在 Node.js 上使用 TiddlyWiki

TiddlyWiki5 包含一组用于在命令行中执行基于 TiddlyWikiFolders、TiddlerFiles 的广泛操作的命令。

例如，以下命令从 TiddlyWiki HTML 文件中加载 tiddlers，然后将其中一个保存为静态 HTML：

tiddlywiki --verbose --load mywiki.html --render ReadMe ./readme.html

从命令行运行 tiddlywiki 会启动 TiddlyWiki 内核，加载核心插件并建立一个空的 wiki 存储。然后，它会从左到右依次处理命令行参数。参数之间用空格分隔。

引入于 v5.1.20 首先，可以有零个或多个由前缀 + 标识的插件引用（用于插件名称）或由 ++ 标识的插件文件夹路径。这些插件将在 TiddlyWikiFolder 中指定的任何插件之外被加载。

下一个参数是可选的 TiddlyWikiFolder 路径，用于加载。如果不存在，则当前目录是

使用。

命令及其各自的参数如下，每个命令由前缀 -- 标识。

tiddlywiki [+<pluginname> | ++<pluginpath>] [<wikipath>] [--<command> [<arg>[,<arg>]]]

例如：

tiddlywiki --version

tiddlywiki +plugins/tiddlywiki/filesystem +plugins/tiddlywiki/tiddlyweb mywiki --listen tiddlywiki ++./mygreatplugin mywiki --listen

Introduced in v5.1.18 诸如 ListenCommand 等支持大量参数的命令可以使用 NamedCommandParameters 使操作更加简便。例如：

tiddlywiki wikipath --listen username=jeremy port=8090

请参阅 Commands 以获取可用命令的完整列表。

在 Node.js 上升级 TiddlyWiki

如果您以常规方式安装了 TiddlyWiki on Node.js，当新版本发布时，您可以使用以下命令进行升级：

npm update -g tiddlywiki

在 Mac 或 Linux 上，您需要像这样添加 sudo：

sudo npm update -g tiddlywiki

另请参阅

Building TiddlyWikiClassic
Customising Tiddler File Naming
Environment Variables on Node.js
Generating Static Sites with TiddlyWiki
How to build a TiddlyWiki5 from individual tiddlers
Installing custom plugins on Node.js
.com/static/Installing%2520official%2520plugins%2520on%2520Node.js.html">在 Node.js 上安装官方插件
Internet Information Services
在 Node.js 上安装 TiddlyWiki 预发布版
MultiTiddlerFiles
MultiTiddlerFileSyntax
NamedCommandParameters
Node.js 上的 TiddlyWiki 脚本
Termux 上的 Node.js
TiddlerFiles
tiddlywiki.files 文件
tiddlywiki.info 文件
TiddlyWikiFolders
使用 Node.js 卸载插件
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with

%2520the%2520client-server%2520edition.html">使用自定义路径前缀配合客户端-服务器版本
使用 TiddlyWiki 进行 GitHub 项目文档管理
使用 TiddlyWiki5 仓库

此 readme 文件由 TiddlyWiki

自动生成