TW5-Bob 项目使用教程
1. 项目的目录结构及介绍
TW5-Bob/
├── plugins/
│ └── OokTech/
│ ├── Bob/
│ └── TWederBob/
├── editions/
│ └── index.html
├── themes/
├── TiddlyWiki5/
├── buildExecutables.sh
└── README.md
目录结构说明
- plugins/: 存放项目所需的插件。默认包含
Bob
和TWederBob
插件。- OokTech/Bob/:
Bob
插件的子模块。 - OokTech/TWederBob/:
TWederBob
插件的子模块。
- OokTech/Bob/:
- editions/: 存放项目的根维基文件。默认包含
index.html
。 - themes/: 存放项目所需的主题文件。默认情况下为空。
- TiddlyWiki5/:
TiddlyWiki
的子模块,用于构建项目。 - buildExecutables.sh: 用于构建可执行文件的脚本。
- README.md: 项目的说明文件。
2. 项目的启动文件介绍
项目的启动文件主要是 buildExecutables.sh
脚本。该脚本用于构建可执行文件,具体步骤如下:
- 克隆仓库: 首先需要克隆
TW5-Bob
仓库到本地。 - 初始化/克隆子模块: 使用
git submodule init
和git submodule update
命令初始化和更新子模块。 - 安装 npm 模块: 使用
npm install
命令安装所需的 npm 模块。 - 安装 node pkg 模块: 使用
npm install -g pkg
命令安装pkg
模块。 - 运行构建脚本: 执行
./buildExecutables.sh
脚本,生成可执行文件。
3. 项目的配置文件介绍
项目的主要配置文件是 editions/index.html
,该文件是 TiddlyWiki
的根维基文件。通过编辑该文件,可以配置项目的初始设置和插件加载。
配置文件说明
- index.html: 该文件包含了
TiddlyWiki
的初始化配置,可以通过编辑该文件来添加或移除插件、主题等。
配置示例
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>TiddlyWiki</title>
<!-- 添加插件 -->
<script src="plugins/OokTech/Bob/plugin.js"></script>
<!-- 添加主题 -->
<link rel="stylesheet" href="themes/my-theme.css">
</head>
<body>
<!-- TiddlyWiki 内容 -->
</body>
</html>
通过以上步骤,您可以成功配置和启动 TW5-Bob
项目。