# wiki-pdf

**Repository Path**: baklib/pdf

## Basic Information

- **Project Name**: wiki-pdf
- **Description**: PDF 网页数字出版模板
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-31
- **Last Updated**: 2026-02-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Baklib PDF 数字出版主题模板

适用于产品手册、技术文档、知识库等场景的 Wiki 主题，支持分页预览与打印/导出 PDF。

### 模板预览

| 文档中心 | 产品手册 | 栏目封面 | 普通页面 | 打印预览 |
| :---: | :---: | :---: | :---: | :---: |
| [![文档中心](./assets/images/schema/index.webp)](./assets/images/schema/index.webp) | [![产品手册](./assets/images/schema/index2.webp)](./assets/images/schema/index2.webp) | [![栏目封面](./assets/images/schema/page-cover.webp)](./assets/images/schema/page-cover.webp) | [![普通页面](./assets/images/schema/page.webp)](./assets/images/schema/page.webp) | [![打印预览](./assets/images/schema/print.webp)](./assets/images/schema/print.webp) |

---

## 使用说明与配置教程

以下内容与站点「关于」页（about.liquid）中的操作说明一致，便于在仓库中查阅并配置站点信息。

### 一、配置入口

在 Baklib 后台进入 **站点 → 主题 → 主题设置**，可对以下分组进行配置。

### 二、打印水印

在主题设置中的 **「打印水印」** 分组下：

- **打印水印文字**：填写后，在打印或导出 PDF 时会在页面上显示为斜角水印；**留空则不显示**水印。
- **页面背景图**：可选。设置后从左上角平铺、全屏宽度拉伸显示；留空则页面背景为白色。
- 页面尺寸、页边距等**不在主题中配置**，请在调起打印预览（Ctrl+P 或点击打印按钮）时，在浏览器的打印对话框中自行选择纸张、边距等。

### 三、封面设计

文档中心首页及「栏目封面」模板采用「封面 + 内容」的排版，封面内容在主题设置中的 **「封面设计」** 分组下配置：

- **页头图片**：封面顶部装饰图（如波浪或书本造型）。
- **页头文字**：页头图片下方的小字。
- **封面标题**：主标题；默认使用页面标题，可自定义。
- **封面副标题**：如作者、出版社等信息。
- **中间图片**：封面中部主图，居中展示。
- **封面页脚**：封面底部作者或出版社信息。

### 四、打印与导出 PDF

在文档中心、栏目封面或文章页**右上角**有一组悬浮按钮（仅屏幕显示，打印时自动隐藏）：

- **目录导航**：点击展开「第 N 页」列表，点击某一页可滚动定位到该页。
- **打印缩放**：下拉选择 80%～200%，仅影响打印/导出时的缩放比例。
- **打印**：调起浏览器打印预览；悬停可查看提示文案。
- **帮助中心**：跳转到使用说明页（/s/about）。

屏幕预览为**两列并排**、上下排版；目录导航可快速跳转到任意页。

**打印时建议在对话框中设置：**

- 将 **「缩放」** 设为 **100%**，避免页面被缩小。
- 将 **「边距」** 设为 **「无」** 或 **「最小」**。
- 取消勾选 **「页眉和页脚」**（本页已包含页眉页脚，勾选可能导致多余空白）。

页面尺寸（如 A4、Letter）和边距由用户在打印对话框中配置，主题不预置这些选项。

### 五、页面类型说明

- **文档中心**：首页采用「封面 + 按目录递归展示全文」的排版，适合手册、文档集；支持分页预览与目录导航。
- **产品手册（列表首页）**：仅展示**一级目录**，Card 风格，每项带「阅读更多」链接到对应详情页；适合作为入口导航。
- **普通页面**：单篇文章的 PDF 风格排版，含标题与正文，可选显示子页面；支持分页与目录导航。
- **栏目封面**：将某页作为栏目的封面。第一页为封面（可单独配置该页的封面项，未填则使用站点封面设置），第二页起循环输出该页的子孙页面；适合分册、分栏目的手册。
- **搜索页**：支持关键词搜索与 AI 对话式检索。

### 六、其他说明

- 主题使用 [Paged.js](https://github.com/pagedjs/pagedjs) 进行分页预览，屏幕预览默认按 A4、2cm 边距；实际打印以用户在打印对话框中的选择为准。
- 更多安装与开发说明见本 README 下方章节。

---

## 安装

- 模板安装指南：https://help.baklib.cn/themes/wiki-pdf
- Baklib 模板安装（Git）：https://gitee.com/baklib/pdf

## 开发

```bash
# 安装依赖
yarn install

# 实时编译：将 src 目录的 JS/CSS 编译到 assets 目录
yarn dev
```

> 需要本地 Node 环境。

```bash
# 可选：安装 guard-livereload，配合浏览器 livereload 插件实现代码改动后自动刷新
bundle install
bundle exec guard
```

## 编译与发布

```bash
yarn build
```

执行后会将 `src/stylesheets`、`src/javascripts` 编译到 `assets` 目录，即可打包或发布主题。