GP 工农解放社刊物生成器
简介
工农解放社文章生成器用于根据MARKDOWN文件和TOML配置文件,自动化生成报纸
技术栈
| 技术栈 | 作用 |
|---|---|
| deno | 提供运行时 |
| playwright无头浏览器 | HTML转PDF |
| markdown-it | Markdown转化为HTML |
| turndown | HTML转Markdown |
| pdf-lib | 写入目录文件 |
| pdf-parse | 解析PDF,构建目录 |
通过Flake 构建环境
本项目提供了 flake.nix,可在 NixOS 和非 NixOS(只要安装了 Nix 且启用 flakes)上获得一致的开发环境。
1. 进入开发环境
nix develop
进入后会自动设置:
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1CHROMIUM_PATH(若能自动探测到 chromium/chrome)
2. 运行
deno run -A main.ts generate pdf
3. 若 CHROMIUM_PATH 未自动设置
手动设置后再运行:
export CHROMIUM_PATH="$(command -v chromium)"
macOS 可使用:
export CHROMIUM_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
使用
deno run main.ts generate pdf
源码文件可以为html或者markdown
配置
目录配置
本项目通过目录中的文件名来生成指定文档,方便非专业人员生成文档
html遵循如下排列顺序
- cover_page.html
- style.html
- fonts.html 或 其他html
- markdown正文
- end_page.html
markdown文件应遵循以下命名规范
专栏顺序::专栏名::此文档在专栏中的顺序::文档名.md
顺序的序号是number类型,可为 任意的 连续的/不连续的 整数/小数/负数/0
├── 26.4.0/
└── cover_page.html
└── 1::foo::2bar.md
└── end_page.html
└── style.html
└── fonts.html
HTML 配置
为了方便注入布局和CSS,本项目默认提供了一些工具CSS类和HTML标签,使用者可以按需修改或覆盖
- global class 控制Markdown文档全局的样式
- c[数字] class 控制指定专栏文档的样式
- c_title class 控制专栏标题的样式
- ch1 tag 控制专栏标题的标签,避免和h1标签重合
生成配置
生成配置可以在config.json中调整
每个配置对象需在settings数组中
每个对象应该包括四个字段,分别为journal,pdf,playwright和md
- journal 控制报刊源码输入位置
- pdf 控制pdf输出位置
- playwright playwright浏览器的配置,具体参考官方文档
- md 控制md文件输出位置
{
"settings": [
{
"journal": {
"from_directory": "./computer_src"
},
"pdf": {
"generate_index": true
},
"playwright": {
"path": "./outputs/computer.pdf",
"format": "A4",
"printBackground": true
},
"md": {
"path": "./outputs/computer.md"
}
},
{
"journal": {
"from_directory": "./mobile_src"
},
"pdf": {
"generate_index": true
},
"playwright": {
"path": "./outputs/mobile.pdf",
"format": "A4",
"printBackground": true
},
"md": {
"path": "./outputs/mobile.md"
}
}
]
}