# qt-assistant

**Repository Path**: birdman1992/qt-assistant

## Basic Information

- **Project Name**: qt-assistant
- **Description**: No description available
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-04
- **Last Updated**: 2025-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Qt Help Viewer

一个基于 Qt 5.15 开发的帮助文档查看工具，用于显示 Qt 帮助文件（.qhc 和 .qch 格式）。

## 功能特性

- ✅ 支持打开和显示 Qt 帮助集合文件（.qhc）和帮助文档文件（.qch）
- ✅ 提供全文搜索功能，快速定位文档内容
- ✅ 支持页面缩放，提升阅读体验
- ✅ 使用 QWebEngineView 渲染 HTML 内容
- ✅ 支持命令行参数传入文档路径
- ✅ 自动从 doc/zh_CN 目录加载文档
- ✅ 内容目录树、索引、搜索、书签功能

## 技术栈

- C++17
- Qt 5.15
  - Qt Core
  - Qt Widgets
  - Qt Help
  - Qt WebEngine

## 构建要求

- CMake 3.16+
- Qt 5.15+
- C++17 编译器

## 构建步骤

### Windows

```powershell
mkdir build
cd build
cmake .. -G "Visual Studio 16 2019" -A x64
cmake --build . --config Release
```

### Linux/macOS

```bash
mkdir build
cd build
cmake ..
make -j$(nproc)
```

## 使用方法

### 基本使用

```bash
# 直接运行，自动从 doc/zh_CN 目录加载
./QtHelpViewer

# 通过命令行参数指定文件
./QtHelpViewer /path/to/doc.qhc

# 使用选项参数
./QtHelpViewer --file /path/to/doc.qhc

# 显示帮助信息
./QtHelpViewer --help

# 显示版本信息
./QtHelpViewer --version
```

### 文件加载优先级

1. 命令行参数指定的文件（最高优先级）
2. 上次打开的文件
3. 程序所在目录的 doc/zh_CN/ 目录
4. 程序所在目录的 doc/ 目录
5. 手动选择文件

## 项目结构

```
QtHelpViewer/
├── CMakeLists.txt
├── README.md
├── src/
│   ├── main.cpp
│   ├── mainwindow.h/cpp
│   ├── helpenginemanager.h/cpp
│   ├── documentviewer.h/cpp
│   ├── contentpanel.h/cpp
│   ├── indexpanel.h/cpp
│   ├── searchpanel.h/cpp
│   ├── bookmarkmanager.h/cpp
│   └── qthelpurlschemehandler.h/cpp
└── resources/
    └── resources.qrc
```

## 许可证

MIT License

## 作者

Created based on Qt Assistant design principles.