从安装部署到日常使用，帮助您快速掌握 TSWIKI 的各项能力。
TSWIKI 采用解压即用的部署方式，不需要安装数据库，也不需要配置容器环境。 完成下载后，按以下步骤即可在数分钟内启动系统。
系统支持 Windows 与 Linux 两种部署形态，适用于个人电脑、内网服务器及私有化环境。 部署过程中不会产生任何对外部网络的依赖。
解压后直接运行启动程序即可。如需开机自启，可将启动程序快捷方式加入系统启动项。
解压后在目录中执行启动脚本。建议以后台方式运行：
cd /opt/tswiki
chmod 744 run.sh
./run.sh如需停止服务，执行目录中对应的停止脚本即可。
默认端口可在配置文件中修改。若部署在服务器上供团队访问，请确认防火墙已放行对应端口， 并为服务器配置固定的内网 IP 地址。
解压后的目录主要包含以下内容：
config/——系统配置文件目录，包含默认存储路径等设置db/——系统使用 Sqlite 数据库目录jre/——系统使用 JAVA 运行环境目录(Windows 版本存在)static/——文档、附件与索引数据存放目录，请定期备份theme/——系统自带主题包目录appLog/——运行时创建的日志目录，排查问题时可优先查看Loader.exe/run.sh / 启动程序——系统启动入口tswiki-lastest.jar / 系统 JAVA 运行包
建议将 static/ 目录纳入定期备份计划，该目录保存了全部知识内容。
系统使用 Markdown 文本格式编写内容，支持标题、链接、图片嵌入、Emoji 表情， 以及表格、公式与流程图等内容形式。图片与附件可直接上传并随文档一同管理。
在 Markdown 文档中通过链接即可创建并嵌入思维导图。导图与文档一同保存， 同样纳入 Git 版本管理。
系统内置 Git 版本管理，可查看文档变更历史与版本差异。同时支持与远程 Git 仓库同步：
您也可以继续使用自己熟悉的编辑器编写内容，将文件上传至仓库后， 系统会在下一次同步时自动更新到站点。
文档资料可通过分类、标签与索引进行组织。系统支持对 Markdown、Word、Excel、PDF 等常见办公文件 建立正文内容索引，检索时可直接命中文件正文内容，而非仅匹配文件名。
自 v1.5.2 起，系统支持 PDF 文件的在线查看与批注。
TSWIKI 可免费使用，支持私有化部署，无需支付授权费用。
所有数据均保存在您本地或自有服务器的 db/ 、static/ 目录中，
系统不依赖任何云端服务，也不会将内容上传至外部网络。
当前版本暂未提供 macOS 原生安装包。macOS 用户可通过安装 JDK、虚拟机或容器方式运行 Linux 版本。
系统适合个人或小型团队使用，支持多人访问与内容共建，并通过 Git 版本管理避免内容冲突与误覆盖，但多人同时对同一文件的修改，系统未做严格版本控制。
备份 db/、data/ 目录即可完整迁移全部内容。
也可启用 Git 远程同步，将内容自动同步至远程仓库作为异地备份（仅Markdown，思维导图、白板文件等），共享文档等需目录备份。