# tswiki

**Repository Path**: x-hd2007/tswiki

## Basic Information

- **Project Name**: tswiki
- **Description**: tswiki
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-18
- **Last Updated**: 2024-01-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [TS WIKI 知识库软件(VER_1.0)](https://tswiki.cn)

* 其他介绍可以访问 https://tswiki.cn 了解。


TS WIKI 目标是做一个可以本地化部署，小型的，适合个人或小型团队的知识管理软件。
* T(iny) S(mall) WIKI

## TS WIKI 功能说明

### 1、最简化的软件依赖和安装
* 依赖的软件最简化。软件只使用 SQLITE 数据库，尽量减少对其他软件的依赖，方便安装使用。
* 在 windows 平台下，绿色安装，下载压缩包，解压即可运行。
* 支持 Linux 系统运行。（**需要安装 OpenJdk**）

### 2、支持 markdown 作为知识库内容编写方式。
* 基于 [editmd](https://pandao.github.io/editor.md/) ，知识页面及内容使用 markdown 标记语言。作为文件的编写和展示工具，支持，代码段、流程图、katax公式、序列图等。

### 3、支持 GIT 进行版本管理工具
* 系统支持 [GIT](https://git-scm.com/book/zh/v2/%E8%B5%B7%E6%AD%A5-%E5%AE%89%E8%A3%85-Git) 进行版本管理，指定 GIT 库目录作为知识库根目录。保存 markdown 文件，同时后台进行 commit 提交。
* 在设置 GIT 远程同步时，后台按设置的时间，自动同步远程库 **（需要用户了解并设置远程库　SSH 免密访问，并规划好 GIT 工作流，避免分支同步出错）**。
* 用户可以使用自己常用的 markdown 编辑器(VS CODE, Typora等)编写内容，GIT 提交后，通过定期同步更新到知识库。
* 系统自身支持 git 库操作，无需安装 git 工具软件。
* 如使用代码托管站点，推荐 [gitee](https://gitee.com/)。

### 4、支持本地图片上传
* 在页面方式编写 markdown 过程中，支持图片文件上传，并在 markdown 文件中使用，可以不依赖外部图片站点。

### 5、支持思维导图
* 软件整合了 kity minder 思维导图，支持 markdown 内链接创建、显示思维导图。
* 思维导图支持 md， km，png 格式文件导出。
* 思维导图在系统内部通过 km 文件格式保存，并使用 GIT 版本管理。

### 6、知识库页面支持附件内容
* 知识页面支持附件上传，与内容相关文件可作为附件上传到页面。
* 附件上传最大限制 32MB。

### 7、支持共享文档上传下载
* 系统支持共享文档上传下载功能。

### 8、全文索引
* 支持 markdown 内容及 word、excel、pdf 文档的全文索引。软件自动定时后台构建内容索引，实现文档内容搜索。

### 9、GIT 目录在线浏览
* 支持 GIT 库目录在线浏览，可以点击查看相关内容。

## [部署指南](./部署指南)

## [启动运行](./启动运行)

## [系统设置](./系统设置)

## [使用说明](./使用说明)

### 说明文档
* 1、系统启动运行后，用户可以在用户手册中查看系统使用说明

## 其他

* 目前 wiki， 思维导图已经支持到任意层级目录结构。

## 免责申明
* 1、本软件为免费软件，用户可自由使用。
* 2、软件中用到的相关组件，版权归属原开发者所有。
* 3、本软件未经严格网络安全检查，请用户自行保障数据完整及安全，任何因对外部署造成的数据损失和安全问题，将不承担责任。

## 软件使用相关组件

界面： [AdminLTE](https://adminlte.io/)

Markdown 编辑器： [Editor.md](https://pandao.github.io/editor.md/)

思维导图 : [kityminder-editor](https://github.com/fex-team/kityminder-editor)

全文索引：lucene