# relaxReader

**Repository Path**: chengweix/relaxReader

## Basic Information

- **Project Name**: relaxReader
- **Description**: Relax Book Reader 是一个运行在 VS Code Panel 区域中的阅读器插件，支持在独立阅读面板中阅读 TXT、PDF、EPUB 文件，并提供目录导航、阅读位置恢复、最近阅读记录、主题背景自定义等能力。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-04-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Relax Book Reader

> **提示**：本插件已更名为 [**ReaderX**](https://marketplace.visualstudio.com/items?itemName=xiaochengcheng.readerx)，ReaderX 为最新版本，建议安装 ReaderX 获取最新功能与更新。

Relax Book Reader 是一个运行在 VS Code Panel 区域中的阅读器插件，支持在独立阅读面板中阅读 `TXT`、`PDF`、`EPUB` 文件，并提供目录导航、阅读位置恢复、最近阅读记录、主题背景自定义等能力。

它适合在写代码、查资料、看文档、阅读电子书时使用，也适合在不切换太多窗口的情况下进行低打扰的碎片化阅读。对于想在工作间隙安静看点内容的人来说，它也可以作为一个相对低调的“摸鱼”阅读工具。  

## 功能特性

- 支持 `TXT`、`PDF`、`EPUB` 三种常见阅读格式
- 在 VS Code 底部 `Panel`和main区 中提供独立阅读器视图
- 左侧目录、右侧正文的双栏阅读布局
- 支持目录点击跳转
- 支持 `PageUp` / `PageDown` 翻页
- 支持最近阅读记录与阅读位置恢复
- 支持目录树展开、收起和宽度调整
- 支持字体大小调节（增大、缩小、重置）
- 支持中英文 UI 按钮文字切换
- 支持阅读器在主编辑区与底部 Panel 之间切换
- 支持阅读背景与主题切换
- 支持临时伪装模式，通过空格快速隐藏 / 显示当前阅读内容

## 界面预览

基础阅读区

![background-theme](https://gitee.com/chengweix/statics/raw/master/relaxReader/images/reader.png)

主阅读区

![background-theme](https://gitee.com/chengweix/statics/raw/master/relaxReader/images/main-reader.png)

### 最近阅读

![recent-files](https://gitee.com/chengweix/statics/raw/master/relaxReader/images/recent-files.png)

### 位置与阅读进度

![reading-position](https://gitee.com/chengweix/statics/raw/master/relaxReader/images/reading-position.png)

### 背景与主题

![background-theme](https://gitee.com/chengweix/statics/raw/master/relaxReader/images/background-theme.png)

## 支持格式

- `TXT`
- `PDF`
- `EPUB`

## 使用方式

1. 安装扩展后，在 VS Code 的 `Panel` 区域打开阅读器。
2. 点击“打开文件”选择需要阅读的 `TXT`、`PDF` 或 `EPUB` 文件。
3. 在左侧目录中点击章节，可跳转到正文对应位置。
4. 使用 `PageDown` 和 `PageUp` 快捷键进行翻页。
5. 通过工具栏按钮将阅读器在主编辑区与底部 Panel 之间切换。
6. 使用字体调节按钮缩小、重置或放大文字大小。
7. 点击工具栏右侧的 `中文 / EN` 按钮切换界面按钮文字语言。
8. 通过"最近阅读"快速恢复上次阅读的文件和位置。

## 快捷键

- `Alt+R`：切换阅读器显示状态
- `PageDown`：下一页
- `PageUp`：上一页
- `Space`：切换伪装模式

## 命令

- `Reader: Open`
- `Reader: Toggle`
- `Reader: Focus`
- `Reader: Open File`
- `Reader: Show Recent Files`
- `Reader: Toggle Host Area`
- `Reader: Next Page`
- `Reader: Previous Page`

## 适用场景

- 在 VS Code 中直接阅读技术文档、电子书和教材
- 边写代码边看参考资料，不频繁切换应用窗口
- 在工作过程中快速查看长文内容，保持相对低打扰的阅读体验
- 在一些不方便频繁切换窗口的场景下，作为一个低调的“摸鱼”阅读面板使用
- 用统一的阅读界面管理最近阅读文件和上次阅读位置

## 注意事项

- `TXT` 文件建议使用 `UTF-8` 编码
- `PDF` 渲染基于 `PDF.js`
- `EPUB` 当前以常见结构文件为主，复杂样式文件可能存在兼容性差异
- Marketplace 页面中的截图建议放在公开仓库中，避免图片链接失效

## 更新计划

- 优化 `EPUB` 目录识别与跳转精度
- 增加更多阅读主题与显示选项
- 继续优化扩展体积与运行性能

## English

English documentation is included in this repository as `README.en.md`.