annProg/PanBook 开源项目中文解读：技术栈、适用场景与上手建议

290

BSD 3-Clause "New" or "Revised" License

项目介绍

annProg/PanBook 是一个托管在 GitHub 上的开源项目，主要使用 TeX 编写，采用 BSD 3-Clause "New" or "Revised" License 许可证，目前获得 290 个 Star、33 次 Fork。

仓库全名: annProg/PanBook
开源许可证: BSD 3-Clause "New" or "Revised" License
Star 数: 290
Fork 数: 33
未关闭 Issue: 11

README 摘要

完整内容见 GitHub 原始 README 或本页。

常见问题

PanBook 用什么语言开发？

主要使用 TeX 编写，采用 BSD 3-Clause "New" or "Revised" License 许可证，目前有 290 个 Star。

PanBook 可以免费商用吗？

如何获取 PanBook 的源码？

可以直接克隆仓库：git clone https://github.com/annProg/PanBook.git，默认分支为 master；安装与运行步骤见仓库 README。

PanBook 最近还在维护吗？

仓库最近一次更新为 2023年3月22日，当前有 11 个未关闭 Issue；Star 数为 290，可作为社区活跃度的参考。

关于

Pandoc LaTeX，Epub模板，用于生成书籍，幻灯片(beamer)，简历，论文等（cv, thesis, ebook,beamer)

描述取自 GitHub 官方 API，中文内容由 GitRead 中文社区编辑团队整理。

简要分析

热度分

360

价值分

183

活跃状态

活跃

beamer cv epub latex markdown markdown-resume pandoc pandoc-template resume thesis

GitHub

README

简介

PanBook基于Pandoc的lua filter功能，适配各种书籍，论文，幻灯片及简历的LaTeX或EPUB模板。目标是使用Pandoc's Markdown作为写作语言，实现一次编写多次生成。

预览

Book	Article	Thesis	Slide	CV
ElegantBook	ctexart	Demo Thesis	metropolis	moderncv-classic
	elegantnote		solarized	resume
CTeXBook	elegantpaper		material	TMR
CTeXBook-mobile			Execushares	moderncv-fancy
Epub			classyslides	moderncv-banking
			elegance	moderncv-casual
			Hest	moderncv-oldstyle
			opensuse
			Xiaoshan
	more	more	more	more

快速开始

以Windows 10为例，演示如何使用。首先安装以下依赖软件

msys2（ Linux 及 OS X 请忽略此步骤）
texlive 2018 或以上版本
Pandoc 2.17.1.1
pandoc-crossref 对应版本并安装到path目录下（建议和Pandoc放同一目录，即/c/Users/yourname/AppData/Local/Pandoc）

另外，本项目需要使用 4.x 版本以上的 bash, OS X 用户可能需要升级 bash 版本，参见 stackoverflow

然后下载本项目，打开msys2，假设工作目录为/d/dev

# 首先安装 git，msys2 包管理工具为 pacman
$ pacman -Ss git     # 查询软件包
$ pacman -S git      # 安装软件包
$ cd /d/dev
$ git clone https://github.com/annProg/PanBook

设置环境变量

需要将本项目，texlive及Pandoc加入环境变量，编辑~/.bashrc，加入以下内容

$ tail -n 1 ~/.bashrc
export PATH=$PATH:/d/texlive/2018/bin/win32:/d/dev/PanBook:/c/Users/myname/AppData/Local/Pandoc

开始使用

# 新建项目目录
$ mkdir /d/dev/mybook
$ cd /d/dev/mybook
# 生成示例 book 文档，编译结果在 build 目录
$ panbook book
# 查看帮助
$ panbook -h

然后编写 src 目录下的 Markdown 源文件。图片放在 src/images 下。

贡献指南

欢迎提交Issue和Pull Request。extensions, styles开发流程请参考 PanBook 手册第四章。

演示

使用本项目编译的书籍（欢迎加入此列表）

免责声明

请仔细阅读本软件 Licence

因此，当用于正式场合（比如学位论文）时，请您自行评估风险。

致谢

PanBook适配了一些开源LaTeX模板，列表如下：

Book	Article	Slide	CV
ElegantBook	ElegantNote		moderncv
	ElegantPaper	more	resume
			tmr

PanBook